areas
(array) Array of articles containing the following properties
Array Items
name |
(string) The name of the article.
|
abstract |
(string) Abstract / Short description(rich text)
|
description |
(string) Description (rich text)
|
type
(string) Type of the article.
Enum:
-
(string) point
-
(string) tour
-
(string) area
|
invisible |
(bool) The invisible/visible state. Similarly to the public/private state an article is only
visible to its own client if it is set to be invisible.
|
tipFamous |
(bool) Tip: Famous
|
tipHighlight |
(bool) Whether this event has been marked as a highlight.
|
tipIdyllic |
(bool) Tip: Idyllic
|
tipNatural |
(bool) Tip: Close to nature & quiet:
|
tipOffTheTrack |
(bool) Tip: Off the track
|
tipOnlyHere |
(bool) Tip: Only exists here
|
tipPopular |
(bool) Tip: Gladly visited
|
tipTypicalForRegion |
(bool) Tip: Typical for the region
|
currentInformation |
(string) Current information about this article.
|
apiVersion |
(int)
|
author |
(string) Display name of author for this item.
|
longitude |
(?float)
|
latitude |
(?float)
|
copyright |
(string|null) The holder of the copyright.
|
sourceInformationLink |
(string|null) Link to information about the source of the item.
|
license
(string|null) License of the item or NULL if no license set.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
highlight |
(bool) Whether this event has been marked as a highlight.
|
locale |
(string) The current language of the category
|
createdAt |
The date at which the article was created. |
updatedAt |
The date at which the article was last updated. |
primaryCategory
(object) The primary category.
Properties
name |
(string) Name of the category.
|
nameWithParents |
(string) Name of the category including all of it's parents. The names of parents
and children are separated by the character » .
|
rootline |
(array) All category ids from the root up to this category
|
rootlineNames |
(array) All category names from the root up to this category
|
invisible |
(bool) Whether the category is currently invisible.
|
type
Type of the category.
Enum:
-
(string) root
-
(string) point
-
(string) event
-
(string) tour
-
(string) event_host
-
(string) area
-
(string) city
|
fieldGroupsGeneral
(array) Array of the general field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsSpecific
(array) Array of the specific field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsHighlight
(array) Array of the highlight field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupTypesWithParents
(array) Array of all field groups that belong to the category including inherited
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
|
address
(object) The address of the point (only if type=point)
Properties
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
client
(object) The assigned client
Properties
crmLink |
(string) Link to our CRM (Freshsales) with more information about the customer.
|
customerAbbreviation |
(string) Customer abbreviation only used for internal communication.
|
name |
(string) Name of the client.
|
url |
(string) URL of the clients Website.
|
plan |
(string) Which license model the customer has with us.
|
email |
(string)
|
phoneNumber |
(string)
|
title |
(string)
|
linkToToubizUsageDetail |
(string) Link to a detail page with information about the customer’s use of
my.toubiz.
|
factor |
(float) How much the customer pays for the license.
|
id |
(string|null) The primary UUID
|
logo
(object) Logo of the client.
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
contactPerson
(object) Contact person of the client.
Properties
type |
(string) Type of the user. Can have one of the following values: editor, manager, admin.
|
username |
(string) Unique username that identifier the user.
|
firstName |
(string) First name of the user .
|
lastName |
(string) Last name of the user.
|
company |
(string) Company the user works for.
|
email |
(string) E-Mail address of the user. Should be unique in the system.
|
tosAcceptedAt |
(date|null) Time at which the user has accepted the terms of service.
|
lastLoginAt |
(date|null) Time of the users last login.
|
displayName |
(string) Full name to display.
|
client
(object) Name and ID of the client to which the user belongs
Properties
id |
(string) ID of the client
|
name |
(string) Name of the client
|
|
|
|
externalIds |
(array) The id of this article for a number of external services.
|
geocoordinates |
(array) The geocoordinates of the article.
|
point
(object) Point specific attributes. Only returned if the article is of the type point.
Properties
gettingThere |
(string) How to get to the point.
|
status |
(string) The open/closed status.
|
price
freeEntry |
(bool) Whether entry is free. Setting this property to true
disables the price table as a price table for a free entry does
not make any sense.
|
priceComment |
(string) Comments about the pricing. May be rich-text.
|
currencies |
(array) An array of accepted currencies.
|
marketingPriceComment |
(string) Comments about the marketing pricing.
|
marketingPrices
(array) One price per currency for the promotional purpose.
Array Items
id |
string The id of the marketing price.
|
currency |
string The currency.
|
price |
float The price.
|
|
priceGroups
(array) Price groups and their defined fields
Array Items
comment |
(string) Comment to a price group
|
title |
(string) Title to a price group
|
Array Items
comment |
(string) Comment to a price entry
|
title |
(string) Title to a price entry
|
eur |
(float) The price in EUR
|
chf |
(float) The price in CHF
|
|
|
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use article.point.booking.information instead.
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
area
(object) Area specific attributes. Only returned if the article is of the type area.
Properties
gettingThere |
(string)
|
claim |
(string)
|
facts |
(string)
|
zipCodes |
(array<ZipCode>)
|
communalLink |
(string) Link to the communal homepage.
|
communalLogo |
(File)
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
highlightCollection
(object) Collection of highlight articles
Properties
name |
(string) Name of the collection.
|
type |
(string) Type of the collection. Can be one of article or event .
|
id |
(string|null) The primary UUID
|
articles |
(int[]) Array of article ids that belong to this collection (only for type=article )
|
events |
(int[]) Array of event ids that belong to this collection (only for type=event )
|
preview |
(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
|
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
tour
(object) Tour specific attributes. Only returned if the article is of the type tour.
Properties
startPoint |
(string) Information about the starting point of the tour. May be rich-text.
|
startPointLocation |
(TourLocation|null) Information about the location of starting point of the tour.
|
endPoint |
(string) Information about the end point of the tour. May be rich-text.
|
endPointLocation |
(TourLocation|null) Information about the location of end point of the tour.
|
endPointToStartPoint |
(string) Information about getting from the end point back to the start point.
|
startPointGettingThere |
(string) Information about start point getting there. May be rich-text.
|
authorTip |
(string) Tips by the author. May be rich-text.
|
safetyInformation |
(string) Important safety information for the user. May be rich-text.
|
gear |
(string) Gear that is recommended for this tour. May be rich-text.
|
moreInformation |
(string) General additional information. May be rich-text.
|
approach |
(string) Information about how to navigate around the tour. May be rich-text.
|
directions |
(string) Directions on how to find the start point. May be rich-text.
|
publicTransit |
(string) Information about public transit. May be rich-text.
|
publicTransportGettingThere |
(string) Information about public transport getting there. May be rich-text.
|
parking |
(string) Information about the parking situation. May be rich-text.
|
endPointParking |
(string) Information about tour end point parking situation. May be rich-text.
|
literature |
(string) Additional literature about the tour.
|
trustedMaps |
(string) List of trusted / recommended maps. May be rich-text.
|
protectedAreas |
(string) Information about protected areas in and around the tour. May be rich-text.
|
typeOfTour |
(string) The type of tour (loop tour, one way tour, etc).
|
trackType |
(string) The type of track (foot, bike, car).
|
difficulty |
(int|null) 0-2 difficulty rating of the tour.
|
fitness |
(int) 0-5 fitness rating of the tour.
|
technique |
(int) 0-5 technique rating of the tour.
|
experience |
(int) 0-5 experience rating of the tour.
|
landscape |
(int) 0-5 landscape rating of the tour.
|
scenic |
(bool) Scenic
|
geology |
(bool) Geological highlights
|
flora |
(bool) Botanical highlights
|
culture |
(bool) Cultural highlights
|
fauna |
(bool) Fauna highlights
|
healthyClimate |
(bool) Healthy climate
|
refreshmentPoints |
(bool) Refreshment points
|
sights |
(bool) Sights
|
terrain |
(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath',
'nature', 'miscellaneous')
|
signPosts |
(array<Media>) The different Sign Guide Posts of a Tour
|
status
Tour (opening-) status.
Enum:
-
(string) none
-
(string) open
-
(string) closed
|
geometry
(object) GeoJSON data for tour geometries. Does not apply to stage tours
Properties
|
points |
(array) Point data for tours. Does not apply to stage tours.
|
recommendedTimeOfTravel
(object) Information about which months are recommended to travel in.
Properties
january |
(bool) Whether january is a recommended travel time.
|
february |
(bool) Whether february is a recommended travel time.
|
march |
(bool) Whether march is a recommended travel time.
|
april |
(bool) Whether april is a recommended travel time.
|
may |
(bool) Whether may is a recommended travel time.
|
june |
(bool) Whether june is a recommended travel time.
|
july |
(bool) Whether july is a recommended travel time.
|
august |
(bool) Whether august is a recommended travel time.
|
september |
(bool) Whether september is a recommended travel time.
|
october |
(bool) Whether october is a recommended travel time.
|
november |
(bool) Whether november is a recommended travel time.
|
december |
(bool) Whether december is a recommended travel time.
|
|
trackInformation
(array) Array of all GPS Track information.
Array Items
duration |
(int) Estimated duration of the tour in minutes
|
distance |
(int) Distance the tour spans in meters
|
elevationUp |
(float) Meters of elevation upwards.
|
elevationDown |
(float) Meters of elevation downwards.
|
highestPoint |
(float) Highest point of the tour.
|
lowestPoint |
(float) Lowest point of the tour.
|
premiumTourEditHash |
(string|null) Hash that can be used to restore the tour path in the toursprung editor.
See also: MTK.RoutePlanner#loadFromHash.
|
trackType
(string) Type of the track
Enum:
-
(string) bike
-
(string) foot
-
(string) car
|
premiumTourEditType
(string|null) Type of the editing view
Enum:
-
(NULL)
-
(string) car
-
(string) foot
-
(string) bike
|
file
(object|null) GPX / KML Track file associated with this track
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
|
tourStageCollections
(array) Array of all tour stage collections.
Array Items
name |
(string)
|
sorting |
(int)
|
stages |
(array<Article>) The tour stages (tour articles with typeOfTour "stage".
|
|
trackDownload
(array) Array of all track downloads in various formats.
Array Items
url |
(string) The public download url.
|
type |
(string) The file type (gpx, kml, etc.).
|
reference
(array) Information about the track being referenced. Could be a single tour or a tour stage collection.
Properties
id |
(string) The id of the object.
|
type |
(string) The model type being referenced.
|
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use point.booking.information instead.
|
|
capacity
(object) Information about the capacity (total, current, etc.)
Properties
totalCapacity |
(int) The total capacity as an absolute number.
|
currentLevel |
(int) The current level of visitors.
|
currentLevelType |
(int) If the current level is an absolute number or a percentage.
|
currentLevelUpdatedAt |
(date) When the current level was last updated.
|
currentLevelPercentage |
(int|null) The normalized current level. Is calculated internally.
|
prediction |
(array) The predicted visitors over the course of a week in 3hr steps,
starting at 3am and ending at midnight.
|
predictionFor |
(string) The default scenario the prediction is for (bad weather, etc.)
|
predictionNotice |
(array) Additional information, e.g. about how the weather affects the prediction
values.
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
webMediaLinks
(object) A list of web media links.
Array Items
type |
(string) The type of the web link
|
url |
(string) The URL itself pointing ot an external media object
|
title |
(string|null) An optional title for displaying the link
|
description |
(string|null) An optional description for this link
|
sorting |
(int) If multiple links exist for the same type, this sorting is used (the highest first)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
|
sourceSystemInformation
documentation |
(array) A list of source systems this items data is coming from.
|
|
trashed |
(boolean) Indicates whether the item is deleted.
|
|
|
areaAccommodations
(array) Array of articles containing the following properties
Array Items
name |
(string) The name of the article.
|
abstract |
(string) Abstract / Short description(rich text)
|
description |
(string) Description (rich text)
|
type
(string) Type of the article.
Enum:
-
(string) point
-
(string) tour
-
(string) area
|
invisible |
(bool) The invisible/visible state. Similarly to the public/private state an article is only
visible to its own client if it is set to be invisible.
|
tipFamous |
(bool) Tip: Famous
|
tipHighlight |
(bool) Whether this event has been marked as a highlight.
|
tipIdyllic |
(bool) Tip: Idyllic
|
tipNatural |
(bool) Tip: Close to nature & quiet:
|
tipOffTheTrack |
(bool) Tip: Off the track
|
tipOnlyHere |
(bool) Tip: Only exists here
|
tipPopular |
(bool) Tip: Gladly visited
|
tipTypicalForRegion |
(bool) Tip: Typical for the region
|
currentInformation |
(string) Current information about this article.
|
apiVersion |
(int)
|
author |
(string) Display name of author for this item.
|
longitude |
(?float)
|
latitude |
(?float)
|
copyright |
(string|null) The holder of the copyright.
|
sourceInformationLink |
(string|null) Link to information about the source of the item.
|
license
(string|null) License of the item or NULL if no license set.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
highlight |
(bool) Whether this event has been marked as a highlight.
|
locale |
(string) The current language of the category
|
createdAt |
The date at which the article was created. |
updatedAt |
The date at which the article was last updated. |
primaryCategory
(object) The primary category.
Properties
name |
(string) Name of the category.
|
nameWithParents |
(string) Name of the category including all of it's parents. The names of parents
and children are separated by the character » .
|
rootline |
(array) All category ids from the root up to this category
|
rootlineNames |
(array) All category names from the root up to this category
|
invisible |
(bool) Whether the category is currently invisible.
|
type
Type of the category.
Enum:
-
(string) root
-
(string) point
-
(string) event
-
(string) tour
-
(string) event_host
-
(string) area
-
(string) city
|
fieldGroupsGeneral
(array) Array of the general field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsSpecific
(array) Array of the specific field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsHighlight
(array) Array of the highlight field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupTypesWithParents
(array) Array of all field groups that belong to the category including inherited
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
|
address
(object) The address of the point (only if type=point)
Properties
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
client
(object) The assigned client
Properties
crmLink |
(string) Link to our CRM (Freshsales) with more information about the customer.
|
customerAbbreviation |
(string) Customer abbreviation only used for internal communication.
|
name |
(string) Name of the client.
|
url |
(string) URL of the clients Website.
|
plan |
(string) Which license model the customer has with us.
|
email |
(string)
|
phoneNumber |
(string)
|
title |
(string)
|
linkToToubizUsageDetail |
(string) Link to a detail page with information about the customer’s use of
my.toubiz.
|
factor |
(float) How much the customer pays for the license.
|
id |
(string|null) The primary UUID
|
logo
(object) Logo of the client.
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
contactPerson
(object) Contact person of the client.
Properties
type |
(string) Type of the user. Can have one of the following values: editor, manager, admin.
|
username |
(string) Unique username that identifier the user.
|
firstName |
(string) First name of the user .
|
lastName |
(string) Last name of the user.
|
company |
(string) Company the user works for.
|
email |
(string) E-Mail address of the user. Should be unique in the system.
|
tosAcceptedAt |
(date|null) Time at which the user has accepted the terms of service.
|
lastLoginAt |
(date|null) Time of the users last login.
|
displayName |
(string) Full name to display.
|
client
(object) Name and ID of the client to which the user belongs
Properties
id |
(string) ID of the client
|
name |
(string) Name of the client
|
|
|
|
externalIds |
(array) The id of this article for a number of external services.
|
geocoordinates |
(array) The geocoordinates of the article.
|
point
(object) Point specific attributes. Only returned if the article is of the type point.
Properties
gettingThere |
(string) How to get to the point.
|
status |
(string) The open/closed status.
|
price
freeEntry |
(bool) Whether entry is free. Setting this property to true
disables the price table as a price table for a free entry does
not make any sense.
|
priceComment |
(string) Comments about the pricing. May be rich-text.
|
currencies |
(array) An array of accepted currencies.
|
marketingPriceComment |
(string) Comments about the marketing pricing.
|
marketingPrices
(array) One price per currency for the promotional purpose.
Array Items
id |
string The id of the marketing price.
|
currency |
string The currency.
|
price |
float The price.
|
|
priceGroups
(array) Price groups and their defined fields
Array Items
comment |
(string) Comment to a price group
|
title |
(string) Title to a price group
|
Array Items
comment |
(string) Comment to a price entry
|
title |
(string) Title to a price entry
|
eur |
(float) The price in EUR
|
chf |
(float) The price in CHF
|
|
|
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use article.point.booking.information instead.
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
area
(object) Area specific attributes. Only returned if the article is of the type area.
Properties
gettingThere |
(string)
|
claim |
(string)
|
facts |
(string)
|
zipCodes |
(array<ZipCode>)
|
communalLink |
(string) Link to the communal homepage.
|
communalLogo |
(File)
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
highlightCollection
(object) Collection of highlight articles
Properties
name |
(string) Name of the collection.
|
type |
(string) Type of the collection. Can be one of article or event .
|
id |
(string|null) The primary UUID
|
articles |
(int[]) Array of article ids that belong to this collection (only for type=article )
|
events |
(int[]) Array of event ids that belong to this collection (only for type=event )
|
preview |
(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
|
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
tour
(object) Tour specific attributes. Only returned if the article is of the type tour.
Properties
startPoint |
(string) Information about the starting point of the tour. May be rich-text.
|
startPointLocation |
(TourLocation|null) Information about the location of starting point of the tour.
|
endPoint |
(string) Information about the end point of the tour. May be rich-text.
|
endPointLocation |
(TourLocation|null) Information about the location of end point of the tour.
|
endPointToStartPoint |
(string) Information about getting from the end point back to the start point.
|
startPointGettingThere |
(string) Information about start point getting there. May be rich-text.
|
authorTip |
(string) Tips by the author. May be rich-text.
|
safetyInformation |
(string) Important safety information for the user. May be rich-text.
|
gear |
(string) Gear that is recommended for this tour. May be rich-text.
|
moreInformation |
(string) General additional information. May be rich-text.
|
approach |
(string) Information about how to navigate around the tour. May be rich-text.
|
directions |
(string) Directions on how to find the start point. May be rich-text.
|
publicTransit |
(string) Information about public transit. May be rich-text.
|
publicTransportGettingThere |
(string) Information about public transport getting there. May be rich-text.
|
parking |
(string) Information about the parking situation. May be rich-text.
|
endPointParking |
(string) Information about tour end point parking situation. May be rich-text.
|
literature |
(string) Additional literature about the tour.
|
trustedMaps |
(string) List of trusted / recommended maps. May be rich-text.
|
protectedAreas |
(string) Information about protected areas in and around the tour. May be rich-text.
|
typeOfTour |
(string) The type of tour (loop tour, one way tour, etc).
|
trackType |
(string) The type of track (foot, bike, car).
|
difficulty |
(int|null) 0-2 difficulty rating of the tour.
|
fitness |
(int) 0-5 fitness rating of the tour.
|
technique |
(int) 0-5 technique rating of the tour.
|
experience |
(int) 0-5 experience rating of the tour.
|
landscape |
(int) 0-5 landscape rating of the tour.
|
scenic |
(bool) Scenic
|
geology |
(bool) Geological highlights
|
flora |
(bool) Botanical highlights
|
culture |
(bool) Cultural highlights
|
fauna |
(bool) Fauna highlights
|
healthyClimate |
(bool) Healthy climate
|
refreshmentPoints |
(bool) Refreshment points
|
sights |
(bool) Sights
|
terrain |
(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath',
'nature', 'miscellaneous')
|
signPosts |
(array<Media>) The different Sign Guide Posts of a Tour
|
status
Tour (opening-) status.
Enum:
-
(string) none
-
(string) open
-
(string) closed
|
geometry
(object) GeoJSON data for tour geometries. Does not apply to stage tours
Properties
|
points |
(array) Point data for tours. Does not apply to stage tours.
|
recommendedTimeOfTravel
(object) Information about which months are recommended to travel in.
Properties
january |
(bool) Whether january is a recommended travel time.
|
february |
(bool) Whether february is a recommended travel time.
|
march |
(bool) Whether march is a recommended travel time.
|
april |
(bool) Whether april is a recommended travel time.
|
may |
(bool) Whether may is a recommended travel time.
|
june |
(bool) Whether june is a recommended travel time.
|
july |
(bool) Whether july is a recommended travel time.
|
august |
(bool) Whether august is a recommended travel time.
|
september |
(bool) Whether september is a recommended travel time.
|
october |
(bool) Whether october is a recommended travel time.
|
november |
(bool) Whether november is a recommended travel time.
|
december |
(bool) Whether december is a recommended travel time.
|
|
trackInformation
(array) Array of all GPS Track information.
Array Items
duration |
(int) Estimated duration of the tour in minutes
|
distance |
(int) Distance the tour spans in meters
|
elevationUp |
(float) Meters of elevation upwards.
|
elevationDown |
(float) Meters of elevation downwards.
|
highestPoint |
(float) Highest point of the tour.
|
lowestPoint |
(float) Lowest point of the tour.
|
premiumTourEditHash |
(string|null) Hash that can be used to restore the tour path in the toursprung editor.
See also: MTK.RoutePlanner#loadFromHash.
|
trackType
(string) Type of the track
Enum:
-
(string) bike
-
(string) foot
-
(string) car
|
premiumTourEditType
(string|null) Type of the editing view
Enum:
-
(NULL)
-
(string) car
-
(string) foot
-
(string) bike
|
file
(object|null) GPX / KML Track file associated with this track
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
|
tourStageCollections
(array) Array of all tour stage collections.
Array Items
name |
(string)
|
sorting |
(int)
|
stages |
(array<Article>) The tour stages (tour articles with typeOfTour "stage".
|
|
trackDownload
(array) Array of all track downloads in various formats.
Array Items
url |
(string) The public download url.
|
type |
(string) The file type (gpx, kml, etc.).
|
reference
(array) Information about the track being referenced. Could be a single tour or a tour stage collection.
Properties
id |
(string) The id of the object.
|
type |
(string) The model type being referenced.
|
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use point.booking.information instead.
|
|
capacity
(object) Information about the capacity (total, current, etc.)
Properties
totalCapacity |
(int) The total capacity as an absolute number.
|
currentLevel |
(int) The current level of visitors.
|
currentLevelType |
(int) If the current level is an absolute number or a percentage.
|
currentLevelUpdatedAt |
(date) When the current level was last updated.
|
currentLevelPercentage |
(int|null) The normalized current level. Is calculated internally.
|
prediction |
(array) The predicted visitors over the course of a week in 3hr steps,
starting at 3am and ending at midnight.
|
predictionFor |
(string) The default scenario the prediction is for (bad weather, etc.)
|
predictionNotice |
(array) Additional information, e.g. about how the weather affects the prediction
values.
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
webMediaLinks
(object) A list of web media links.
Array Items
type |
(string) The type of the web link
|
url |
(string) The URL itself pointing ot an external media object
|
title |
(string|null) An optional title for displaying the link
|
description |
(string|null) An optional description for this link
|
sorting |
(int) If multiple links exist for the same type, this sorting is used (the highest first)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
|
sourceSystemInformation
documentation |
(array) A list of source systems this items data is coming from.
|
|
trashed |
(boolean) Indicates whether the item is deleted.
|
|
|
areaHighlights
(array) Array of articles containing the following properties
Array Items
name |
(string) The name of the article.
|
abstract |
(string) Abstract / Short description(rich text)
|
description |
(string) Description (rich text)
|
type
(string) Type of the article.
Enum:
-
(string) point
-
(string) tour
-
(string) area
|
invisible |
(bool) The invisible/visible state. Similarly to the public/private state an article is only
visible to its own client if it is set to be invisible.
|
tipFamous |
(bool) Tip: Famous
|
tipHighlight |
(bool) Whether this event has been marked as a highlight.
|
tipIdyllic |
(bool) Tip: Idyllic
|
tipNatural |
(bool) Tip: Close to nature & quiet:
|
tipOffTheTrack |
(bool) Tip: Off the track
|
tipOnlyHere |
(bool) Tip: Only exists here
|
tipPopular |
(bool) Tip: Gladly visited
|
tipTypicalForRegion |
(bool) Tip: Typical for the region
|
currentInformation |
(string) Current information about this article.
|
apiVersion |
(int)
|
author |
(string) Display name of author for this item.
|
longitude |
(?float)
|
latitude |
(?float)
|
copyright |
(string|null) The holder of the copyright.
|
sourceInformationLink |
(string|null) Link to information about the source of the item.
|
license
(string|null) License of the item or NULL if no license set.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
highlight |
(bool) Whether this event has been marked as a highlight.
|
locale |
(string) The current language of the category
|
createdAt |
The date at which the article was created. |
updatedAt |
The date at which the article was last updated. |
primaryCategory
(object) The primary category.
Properties
name |
(string) Name of the category.
|
nameWithParents |
(string) Name of the category including all of it's parents. The names of parents
and children are separated by the character » .
|
rootline |
(array) All category ids from the root up to this category
|
rootlineNames |
(array) All category names from the root up to this category
|
invisible |
(bool) Whether the category is currently invisible.
|
type
Type of the category.
Enum:
-
(string) root
-
(string) point
-
(string) event
-
(string) tour
-
(string) event_host
-
(string) area
-
(string) city
|
fieldGroupsGeneral
(array) Array of the general field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsSpecific
(array) Array of the specific field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsHighlight
(array) Array of the highlight field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupTypesWithParents
(array) Array of all field groups that belong to the category including inherited
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
|
address
(object) The address of the point (only if type=point)
Properties
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
client
(object) The assigned client
Properties
crmLink |
(string) Link to our CRM (Freshsales) with more information about the customer.
|
customerAbbreviation |
(string) Customer abbreviation only used for internal communication.
|
name |
(string) Name of the client.
|
url |
(string) URL of the clients Website.
|
plan |
(string) Which license model the customer has with us.
|
email |
(string)
|
phoneNumber |
(string)
|
title |
(string)
|
linkToToubizUsageDetail |
(string) Link to a detail page with information about the customer’s use of
my.toubiz.
|
factor |
(float) How much the customer pays for the license.
|
id |
(string|null) The primary UUID
|
logo
(object) Logo of the client.
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
contactPerson
(object) Contact person of the client.
Properties
type |
(string) Type of the user. Can have one of the following values: editor, manager, admin.
|
username |
(string) Unique username that identifier the user.
|
firstName |
(string) First name of the user .
|
lastName |
(string) Last name of the user.
|
company |
(string) Company the user works for.
|
email |
(string) E-Mail address of the user. Should be unique in the system.
|
tosAcceptedAt |
(date|null) Time at which the user has accepted the terms of service.
|
lastLoginAt |
(date|null) Time of the users last login.
|
displayName |
(string) Full name to display.
|
client
(object) Name and ID of the client to which the user belongs
Properties
id |
(string) ID of the client
|
name |
(string) Name of the client
|
|
|
|
externalIds |
(array) The id of this article for a number of external services.
|
geocoordinates |
(array) The geocoordinates of the article.
|
point
(object) Point specific attributes. Only returned if the article is of the type point.
Properties
gettingThere |
(string) How to get to the point.
|
status |
(string) The open/closed status.
|
price
freeEntry |
(bool) Whether entry is free. Setting this property to true
disables the price table as a price table for a free entry does
not make any sense.
|
priceComment |
(string) Comments about the pricing. May be rich-text.
|
currencies |
(array) An array of accepted currencies.
|
marketingPriceComment |
(string) Comments about the marketing pricing.
|
marketingPrices
(array) One price per currency for the promotional purpose.
Array Items
id |
string The id of the marketing price.
|
currency |
string The currency.
|
price |
float The price.
|
|
priceGroups
(array) Price groups and their defined fields
Array Items
comment |
(string) Comment to a price group
|
title |
(string) Title to a price group
|
Array Items
comment |
(string) Comment to a price entry
|
title |
(string) Title to a price entry
|
eur |
(float) The price in EUR
|
chf |
(float) The price in CHF
|
|
|
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use article.point.booking.information instead.
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
area
(object) Area specific attributes. Only returned if the article is of the type area.
Properties
gettingThere |
(string)
|
claim |
(string)
|
facts |
(string)
|
zipCodes |
(array<ZipCode>)
|
communalLink |
(string) Link to the communal homepage.
|
communalLogo |
(File)
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
highlightCollection
(object) Collection of highlight articles
Properties
name |
(string) Name of the collection.
|
type |
(string) Type of the collection. Can be one of article or event .
|
id |
(string|null) The primary UUID
|
articles |
(int[]) Array of article ids that belong to this collection (only for type=article )
|
events |
(int[]) Array of event ids that belong to this collection (only for type=event )
|
preview |
(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
|
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
tour
(object) Tour specific attributes. Only returned if the article is of the type tour.
Properties
startPoint |
(string) Information about the starting point of the tour. May be rich-text.
|
startPointLocation |
(TourLocation|null) Information about the location of starting point of the tour.
|
endPoint |
(string) Information about the end point of the tour. May be rich-text.
|
endPointLocation |
(TourLocation|null) Information about the location of end point of the tour.
|
endPointToStartPoint |
(string) Information about getting from the end point back to the start point.
|
startPointGettingThere |
(string) Information about start point getting there. May be rich-text.
|
authorTip |
(string) Tips by the author. May be rich-text.
|
safetyInformation |
(string) Important safety information for the user. May be rich-text.
|
gear |
(string) Gear that is recommended for this tour. May be rich-text.
|
moreInformation |
(string) General additional information. May be rich-text.
|
approach |
(string) Information about how to navigate around the tour. May be rich-text.
|
directions |
(string) Directions on how to find the start point. May be rich-text.
|
publicTransit |
(string) Information about public transit. May be rich-text.
|
publicTransportGettingThere |
(string) Information about public transport getting there. May be rich-text.
|
parking |
(string) Information about the parking situation. May be rich-text.
|
endPointParking |
(string) Information about tour end point parking situation. May be rich-text.
|
literature |
(string) Additional literature about the tour.
|
trustedMaps |
(string) List of trusted / recommended maps. May be rich-text.
|
protectedAreas |
(string) Information about protected areas in and around the tour. May be rich-text.
|
typeOfTour |
(string) The type of tour (loop tour, one way tour, etc).
|
trackType |
(string) The type of track (foot, bike, car).
|
difficulty |
(int|null) 0-2 difficulty rating of the tour.
|
fitness |
(int) 0-5 fitness rating of the tour.
|
technique |
(int) 0-5 technique rating of the tour.
|
experience |
(int) 0-5 experience rating of the tour.
|
landscape |
(int) 0-5 landscape rating of the tour.
|
scenic |
(bool) Scenic
|
geology |
(bool) Geological highlights
|
flora |
(bool) Botanical highlights
|
culture |
(bool) Cultural highlights
|
fauna |
(bool) Fauna highlights
|
healthyClimate |
(bool) Healthy climate
|
refreshmentPoints |
(bool) Refreshment points
|
sights |
(bool) Sights
|
terrain |
(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath',
'nature', 'miscellaneous')
|
signPosts |
(array<Media>) The different Sign Guide Posts of a Tour
|
status
Tour (opening-) status.
Enum:
-
(string) none
-
(string) open
-
(string) closed
|
geometry
(object) GeoJSON data for tour geometries. Does not apply to stage tours
Properties
|
points |
(array) Point data for tours. Does not apply to stage tours.
|
recommendedTimeOfTravel
(object) Information about which months are recommended to travel in.
Properties
january |
(bool) Whether january is a recommended travel time.
|
february |
(bool) Whether february is a recommended travel time.
|
march |
(bool) Whether march is a recommended travel time.
|
april |
(bool) Whether april is a recommended travel time.
|
may |
(bool) Whether may is a recommended travel time.
|
june |
(bool) Whether june is a recommended travel time.
|
july |
(bool) Whether july is a recommended travel time.
|
august |
(bool) Whether august is a recommended travel time.
|
september |
(bool) Whether september is a recommended travel time.
|
october |
(bool) Whether october is a recommended travel time.
|
november |
(bool) Whether november is a recommended travel time.
|
december |
(bool) Whether december is a recommended travel time.
|
|
trackInformation
(array) Array of all GPS Track information.
Array Items
duration |
(int) Estimated duration of the tour in minutes
|
distance |
(int) Distance the tour spans in meters
|
elevationUp |
(float) Meters of elevation upwards.
|
elevationDown |
(float) Meters of elevation downwards.
|
highestPoint |
(float) Highest point of the tour.
|
lowestPoint |
(float) Lowest point of the tour.
|
premiumTourEditHash |
(string|null) Hash that can be used to restore the tour path in the toursprung editor.
See also: MTK.RoutePlanner#loadFromHash.
|
trackType
(string) Type of the track
Enum:
-
(string) bike
-
(string) foot
-
(string) car
|
premiumTourEditType
(string|null) Type of the editing view
Enum:
-
(NULL)
-
(string) car
-
(string) foot
-
(string) bike
|
file
(object|null) GPX / KML Track file associated with this track
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
|
tourStageCollections
(array) Array of all tour stage collections.
Array Items
name |
(string)
|
sorting |
(int)
|
stages |
(array<Article>) The tour stages (tour articles with typeOfTour "stage".
|
|
trackDownload
(array) Array of all track downloads in various formats.
Array Items
url |
(string) The public download url.
|
type |
(string) The file type (gpx, kml, etc.).
|
reference
(array) Information about the track being referenced. Could be a single tour or a tour stage collection.
Properties
id |
(string) The id of the object.
|
type |
(string) The model type being referenced.
|
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use point.booking.information instead.
|
|
capacity
(object) Information about the capacity (total, current, etc.)
Properties
totalCapacity |
(int) The total capacity as an absolute number.
|
currentLevel |
(int) The current level of visitors.
|
currentLevelType |
(int) If the current level is an absolute number or a percentage.
|
currentLevelUpdatedAt |
(date) When the current level was last updated.
|
currentLevelPercentage |
(int|null) The normalized current level. Is calculated internally.
|
prediction |
(array) The predicted visitors over the course of a week in 3hr steps,
starting at 3am and ending at midnight.
|
predictionFor |
(string) The default scenario the prediction is for (bad weather, etc.)
|
predictionNotice |
(array) Additional information, e.g. about how the weather affects the prediction
values.
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
webMediaLinks
(object) A list of web media links.
Array Items
type |
(string) The type of the web link
|
url |
(string) The URL itself pointing ot an external media object
|
title |
(string|null) An optional title for displaying the link
|
description |
(string|null) An optional description for this link
|
sorting |
(int) If multiple links exist for the same type, this sorting is used (the highest first)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
|
sourceSystemInformation
documentation |
(array) A list of source systems this items data is coming from.
|
|
trashed |
(boolean) Indicates whether the item is deleted.
|
|
|
areaParking
(array) Array of articles containing the following properties
Array Items
name |
(string) The name of the article.
|
abstract |
(string) Abstract / Short description(rich text)
|
description |
(string) Description (rich text)
|
type
(string) Type of the article.
Enum:
-
(string) point
-
(string) tour
-
(string) area
|
invisible |
(bool) The invisible/visible state. Similarly to the public/private state an article is only
visible to its own client if it is set to be invisible.
|
tipFamous |
(bool) Tip: Famous
|
tipHighlight |
(bool) Whether this event has been marked as a highlight.
|
tipIdyllic |
(bool) Tip: Idyllic
|
tipNatural |
(bool) Tip: Close to nature & quiet:
|
tipOffTheTrack |
(bool) Tip: Off the track
|
tipOnlyHere |
(bool) Tip: Only exists here
|
tipPopular |
(bool) Tip: Gladly visited
|
tipTypicalForRegion |
(bool) Tip: Typical for the region
|
currentInformation |
(string) Current information about this article.
|
apiVersion |
(int)
|
author |
(string) Display name of author for this item.
|
longitude |
(?float)
|
latitude |
(?float)
|
copyright |
(string|null) The holder of the copyright.
|
sourceInformationLink |
(string|null) Link to information about the source of the item.
|
license
(string|null) License of the item or NULL if no license set.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
highlight |
(bool) Whether this event has been marked as a highlight.
|
locale |
(string) The current language of the category
|
createdAt |
The date at which the article was created. |
updatedAt |
The date at which the article was last updated. |
primaryCategory
(object) The primary category.
Properties
name |
(string) Name of the category.
|
nameWithParents |
(string) Name of the category including all of it's parents. The names of parents
and children are separated by the character » .
|
rootline |
(array) All category ids from the root up to this category
|
rootlineNames |
(array) All category names from the root up to this category
|
invisible |
(bool) Whether the category is currently invisible.
|
type
Type of the category.
Enum:
-
(string) root
-
(string) point
-
(string) event
-
(string) tour
-
(string) event_host
-
(string) area
-
(string) city
|
fieldGroupsGeneral
(array) Array of the general field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsSpecific
(array) Array of the specific field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsHighlight
(array) Array of the highlight field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupTypesWithParents
(array) Array of all field groups that belong to the category including inherited
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
|
address
(object) The address of the point (only if type=point)
Properties
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
client
(object) The assigned client
Properties
crmLink |
(string) Link to our CRM (Freshsales) with more information about the customer.
|
customerAbbreviation |
(string) Customer abbreviation only used for internal communication.
|
name |
(string) Name of the client.
|
url |
(string) URL of the clients Website.
|
plan |
(string) Which license model the customer has with us.
|
email |
(string)
|
phoneNumber |
(string)
|
title |
(string)
|
linkToToubizUsageDetail |
(string) Link to a detail page with information about the customer’s use of
my.toubiz.
|
factor |
(float) How much the customer pays for the license.
|
id |
(string|null) The primary UUID
|
logo
(object) Logo of the client.
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
contactPerson
(object) Contact person of the client.
Properties
type |
(string) Type of the user. Can have one of the following values: editor, manager, admin.
|
username |
(string) Unique username that identifier the user.
|
firstName |
(string) First name of the user .
|
lastName |
(string) Last name of the user.
|
company |
(string) Company the user works for.
|
email |
(string) E-Mail address of the user. Should be unique in the system.
|
tosAcceptedAt |
(date|null) Time at which the user has accepted the terms of service.
|
lastLoginAt |
(date|null) Time of the users last login.
|
displayName |
(string) Full name to display.
|
client
(object) Name and ID of the client to which the user belongs
Properties
id |
(string) ID of the client
|
name |
(string) Name of the client
|
|
|
|
externalIds |
(array) The id of this article for a number of external services.
|
geocoordinates |
(array) The geocoordinates of the article.
|
point
(object) Point specific attributes. Only returned if the article is of the type point.
Properties
gettingThere |
(string) How to get to the point.
|
status |
(string) The open/closed status.
|
price
freeEntry |
(bool) Whether entry is free. Setting this property to true
disables the price table as a price table for a free entry does
not make any sense.
|
priceComment |
(string) Comments about the pricing. May be rich-text.
|
currencies |
(array) An array of accepted currencies.
|
marketingPriceComment |
(string) Comments about the marketing pricing.
|
marketingPrices
(array) One price per currency for the promotional purpose.
Array Items
id |
string The id of the marketing price.
|
currency |
string The currency.
|
price |
float The price.
|
|
priceGroups
(array) Price groups and their defined fields
Array Items
comment |
(string) Comment to a price group
|
title |
(string) Title to a price group
|
Array Items
comment |
(string) Comment to a price entry
|
title |
(string) Title to a price entry
|
eur |
(float) The price in EUR
|
chf |
(float) The price in CHF
|
|
|
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use article.point.booking.information instead.
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
area
(object) Area specific attributes. Only returned if the article is of the type area.
Properties
gettingThere |
(string)
|
claim |
(string)
|
facts |
(string)
|
zipCodes |
(array<ZipCode>)
|
communalLink |
(string) Link to the communal homepage.
|
communalLogo |
(File)
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
highlightCollection
(object) Collection of highlight articles
Properties
name |
(string) Name of the collection.
|
type |
(string) Type of the collection. Can be one of article or event .
|
id |
(string|null) The primary UUID
|
articles |
(int[]) Array of article ids that belong to this collection (only for type=article )
|
events |
(int[]) Array of event ids that belong to this collection (only for type=event )
|
preview |
(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
|
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
tour
(object) Tour specific attributes. Only returned if the article is of the type tour.
Properties
startPoint |
(string) Information about the starting point of the tour. May be rich-text.
|
startPointLocation |
(TourLocation|null) Information about the location of starting point of the tour.
|
endPoint |
(string) Information about the end point of the tour. May be rich-text.
|
endPointLocation |
(TourLocation|null) Information about the location of end point of the tour.
|
endPointToStartPoint |
(string) Information about getting from the end point back to the start point.
|
startPointGettingThere |
(string) Information about start point getting there. May be rich-text.
|
authorTip |
(string) Tips by the author. May be rich-text.
|
safetyInformation |
(string) Important safety information for the user. May be rich-text.
|
gear |
(string) Gear that is recommended for this tour. May be rich-text.
|
moreInformation |
(string) General additional information. May be rich-text.
|
approach |
(string) Information about how to navigate around the tour. May be rich-text.
|
directions |
(string) Directions on how to find the start point. May be rich-text.
|
publicTransit |
(string) Information about public transit. May be rich-text.
|
publicTransportGettingThere |
(string) Information about public transport getting there. May be rich-text.
|
parking |
(string) Information about the parking situation. May be rich-text.
|
endPointParking |
(string) Information about tour end point parking situation. May be rich-text.
|
literature |
(string) Additional literature about the tour.
|
trustedMaps |
(string) List of trusted / recommended maps. May be rich-text.
|
protectedAreas |
(string) Information about protected areas in and around the tour. May be rich-text.
|
typeOfTour |
(string) The type of tour (loop tour, one way tour, etc).
|
trackType |
(string) The type of track (foot, bike, car).
|
difficulty |
(int|null) 0-2 difficulty rating of the tour.
|
fitness |
(int) 0-5 fitness rating of the tour.
|
technique |
(int) 0-5 technique rating of the tour.
|
experience |
(int) 0-5 experience rating of the tour.
|
landscape |
(int) 0-5 landscape rating of the tour.
|
scenic |
(bool) Scenic
|
geology |
(bool) Geological highlights
|
flora |
(bool) Botanical highlights
|
culture |
(bool) Cultural highlights
|
fauna |
(bool) Fauna highlights
|
healthyClimate |
(bool) Healthy climate
|
refreshmentPoints |
(bool) Refreshment points
|
sights |
(bool) Sights
|
terrain |
(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath',
'nature', 'miscellaneous')
|
signPosts |
(array<Media>) The different Sign Guide Posts of a Tour
|
status
Tour (opening-) status.
Enum:
-
(string) none
-
(string) open
-
(string) closed
|
geometry
(object) GeoJSON data for tour geometries. Does not apply to stage tours
Properties
|
points |
(array) Point data for tours. Does not apply to stage tours.
|
recommendedTimeOfTravel
(object) Information about which months are recommended to travel in.
Properties
january |
(bool) Whether january is a recommended travel time.
|
february |
(bool) Whether february is a recommended travel time.
|
march |
(bool) Whether march is a recommended travel time.
|
april |
(bool) Whether april is a recommended travel time.
|
may |
(bool) Whether may is a recommended travel time.
|
june |
(bool) Whether june is a recommended travel time.
|
july |
(bool) Whether july is a recommended travel time.
|
august |
(bool) Whether august is a recommended travel time.
|
september |
(bool) Whether september is a recommended travel time.
|
october |
(bool) Whether october is a recommended travel time.
|
november |
(bool) Whether november is a recommended travel time.
|
december |
(bool) Whether december is a recommended travel time.
|
|
trackInformation
(array) Array of all GPS Track information.
Array Items
duration |
(int) Estimated duration of the tour in minutes
|
distance |
(int) Distance the tour spans in meters
|
elevationUp |
(float) Meters of elevation upwards.
|
elevationDown |
(float) Meters of elevation downwards.
|
highestPoint |
(float) Highest point of the tour.
|
lowestPoint |
(float) Lowest point of the tour.
|
premiumTourEditHash |
(string|null) Hash that can be used to restore the tour path in the toursprung editor.
See also: MTK.RoutePlanner#loadFromHash.
|
trackType
(string) Type of the track
Enum:
-
(string) bike
-
(string) foot
-
(string) car
|
premiumTourEditType
(string|null) Type of the editing view
Enum:
-
(NULL)
-
(string) car
-
(string) foot
-
(string) bike
|
file
(object|null) GPX / KML Track file associated with this track
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
|
tourStageCollections
(array) Array of all tour stage collections.
Array Items
name |
(string)
|
sorting |
(int)
|
stages |
(array<Article>) The tour stages (tour articles with typeOfTour "stage".
|
|
trackDownload
(array) Array of all track downloads in various formats.
Array Items
url |
(string) The public download url.
|
type |
(string) The file type (gpx, kml, etc.).
|
reference
(array) Information about the track being referenced. Could be a single tour or a tour stage collection.
Properties
id |
(string) The id of the object.
|
type |
(string) The model type being referenced.
|
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use point.booking.information instead.
|
|
capacity
(object) Information about the capacity (total, current, etc.)
Properties
totalCapacity |
(int) The total capacity as an absolute number.
|
currentLevel |
(int) The current level of visitors.
|
currentLevelType |
(int) If the current level is an absolute number or a percentage.
|
currentLevelUpdatedAt |
(date) When the current level was last updated.
|
currentLevelPercentage |
(int|null) The normalized current level. Is calculated internally.
|
prediction |
(array) The predicted visitors over the course of a week in 3hr steps,
starting at 3am and ending at midnight.
|
predictionFor |
(string) The default scenario the prediction is for (bad weather, etc.)
|
predictionNotice |
(array) Additional information, e.g. about how the weather affects the prediction
values.
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
webMediaLinks
(object) A list of web media links.
Array Items
type |
(string) The type of the web link
|
url |
(string) The URL itself pointing ot an external media object
|
title |
(string|null) An optional title for displaying the link
|
description |
(string|null) An optional description for this link
|
sorting |
(int) If multiple links exist for the same type, this sorting is used (the highest first)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
|
sourceSystemInformation
documentation |
(array) A list of source systems this items data is coming from.
|
|
trashed |
(boolean) Indicates whether the item is deleted.
|
|
|
areaPublicTransport
(array) Array of articles containing the following properties
Array Items
name |
(string) The name of the article.
|
abstract |
(string) Abstract / Short description(rich text)
|
description |
(string) Description (rich text)
|
type
(string) Type of the article.
Enum:
-
(string) point
-
(string) tour
-
(string) area
|
invisible |
(bool) The invisible/visible state. Similarly to the public/private state an article is only
visible to its own client if it is set to be invisible.
|
tipFamous |
(bool) Tip: Famous
|
tipHighlight |
(bool) Whether this event has been marked as a highlight.
|
tipIdyllic |
(bool) Tip: Idyllic
|
tipNatural |
(bool) Tip: Close to nature & quiet:
|
tipOffTheTrack |
(bool) Tip: Off the track
|
tipOnlyHere |
(bool) Tip: Only exists here
|
tipPopular |
(bool) Tip: Gladly visited
|
tipTypicalForRegion |
(bool) Tip: Typical for the region
|
currentInformation |
(string) Current information about this article.
|
apiVersion |
(int)
|
author |
(string) Display name of author for this item.
|
longitude |
(?float)
|
latitude |
(?float)
|
copyright |
(string|null) The holder of the copyright.
|
sourceInformationLink |
(string|null) Link to information about the source of the item.
|
license
(string|null) License of the item or NULL if no license set.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
highlight |
(bool) Whether this event has been marked as a highlight.
|
locale |
(string) The current language of the category
|
createdAt |
The date at which the article was created. |
updatedAt |
The date at which the article was last updated. |
primaryCategory
(object) The primary category.
Properties
name |
(string) Name of the category.
|
nameWithParents |
(string) Name of the category including all of it's parents. The names of parents
and children are separated by the character » .
|
rootline |
(array) All category ids from the root up to this category
|
rootlineNames |
(array) All category names from the root up to this category
|
invisible |
(bool) Whether the category is currently invisible.
|
type
Type of the category.
Enum:
-
(string) root
-
(string) point
-
(string) event
-
(string) tour
-
(string) event_host
-
(string) area
-
(string) city
|
fieldGroupsGeneral
(array) Array of the general field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsSpecific
(array) Array of the specific field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupsHighlight
(array) Array of the highlight field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
fieldGroupTypesWithParents
(array) Array of all field groups that belong to the category including inherited
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
(array) Tags can be added to flag blueprints for special treatment. This can be a
a different displaying, no displaying, etc.
|
hidden |
(array<int,string>)
|
|
awardSets
(array) Array of award sets connected to this field set
Array Items
title |
(string)
|
icon |
(string)
|
allowMultiple |
(bool)
|
awardBlueprints |
(array<AwardBlueprint>)
|
dynamicFieldSets |
(array<DynamicFieldSet>)
|
showInList |
(bool)
|
type |
(string)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
|
|
|
address
(object) The address of the point (only if type=point)
Properties
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
client
(object) The assigned client
Properties
crmLink |
(string) Link to our CRM (Freshsales) with more information about the customer.
|
customerAbbreviation |
(string) Customer abbreviation only used for internal communication.
|
name |
(string) Name of the client.
|
url |
(string) URL of the clients Website.
|
plan |
(string) Which license model the customer has with us.
|
email |
(string)
|
phoneNumber |
(string)
|
title |
(string)
|
linkToToubizUsageDetail |
(string) Link to a detail page with information about the customer’s use of
my.toubiz.
|
factor |
(float) How much the customer pays for the license.
|
id |
(string|null) The primary UUID
|
logo
(object) Logo of the client.
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
contactPerson
(object) Contact person of the client.
Properties
type |
(string) Type of the user. Can have one of the following values: editor, manager, admin.
|
username |
(string) Unique username that identifier the user.
|
firstName |
(string) First name of the user .
|
lastName |
(string) Last name of the user.
|
company |
(string) Company the user works for.
|
email |
(string) E-Mail address of the user. Should be unique in the system.
|
tosAcceptedAt |
(date|null) Time at which the user has accepted the terms of service.
|
lastLoginAt |
(date|null) Time of the users last login.
|
displayName |
(string) Full name to display.
|
client
(object) Name and ID of the client to which the user belongs
Properties
id |
(string) ID of the client
|
name |
(string) Name of the client
|
|
|
|
externalIds |
(array) The id of this article for a number of external services.
|
geocoordinates |
(array) The geocoordinates of the article.
|
point
(object) Point specific attributes. Only returned if the article is of the type point.
Properties
gettingThere |
(string) How to get to the point.
|
status |
(string) The open/closed status.
|
price
freeEntry |
(bool) Whether entry is free. Setting this property to true
disables the price table as a price table for a free entry does
not make any sense.
|
priceComment |
(string) Comments about the pricing. May be rich-text.
|
currencies |
(array) An array of accepted currencies.
|
marketingPriceComment |
(string) Comments about the marketing pricing.
|
marketingPrices
(array) One price per currency for the promotional purpose.
Array Items
id |
string The id of the marketing price.
|
currency |
string The currency.
|
price |
float The price.
|
|
priceGroups
(array) Price groups and their defined fields
Array Items
comment |
(string) Comment to a price group
|
title |
(string) Title to a price group
|
Array Items
comment |
(string) Comment to a price entry
|
title |
(string) Title to a price entry
|
eur |
(float) The price in EUR
|
chf |
(float) The price in CHF
|
|
|
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use article.point.booking.information instead.
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
area
(object) Area specific attributes. Only returned if the article is of the type area.
Properties
gettingThere |
(string)
|
claim |
(string)
|
facts |
(string)
|
zipCodes |
(array<ZipCode>)
|
communalLink |
(string) Link to the communal homepage.
|
communalLogo |
(File)
|
address
name |
(?string) Name of the address (e.g. name of the building or enterprise).
|
street |
(?string) Street name.
|
streetNumber |
(?string) Street number.
|
zip |
(?string) ZIP Code of the city.
|
city |
(?string) Name of the city.
|
stateCode |
(?int) The integer code of the state. Follows the AGS in Germany.
|
state |
(?string) The name of the state.
|
country |
(string) 2-digit Country code.
|
|
highlightCollection
(object) Collection of highlight articles
Properties
name |
(string) Name of the collection.
|
type |
(string) Type of the collection. Can be one of article or event .
|
id |
(string|null) The primary UUID
|
articles |
(int[]) Array of article ids that belong to this collection (only for type=article )
|
events |
(int[]) Array of event ids that belong to this collection (only for type=event )
|
preview |
(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
|
|
latitude |
(string) Deprecated: Use article.latitude instead.
|
longitude |
(string) Deprecated: Use article.longitude instead.
|
|
tour
(object) Tour specific attributes. Only returned if the article is of the type tour.
Properties
startPoint |
(string) Information about the starting point of the tour. May be rich-text.
|
startPointLocation |
(TourLocation|null) Information about the location of starting point of the tour.
|
endPoint |
(string) Information about the end point of the tour. May be rich-text.
|
endPointLocation |
(TourLocation|null) Information about the location of end point of the tour.
|
endPointToStartPoint |
(string) Information about getting from the end point back to the start point.
|
startPointGettingThere |
(string) Information about start point getting there. May be rich-text.
|
authorTip |
(string) Tips by the author. May be rich-text.
|
safetyInformation |
(string) Important safety information for the user. May be rich-text.
|
gear |
(string) Gear that is recommended for this tour. May be rich-text.
|
moreInformation |
(string) General additional information. May be rich-text.
|
approach |
(string) Information about how to navigate around the tour. May be rich-text.
|
directions |
(string) Directions on how to find the start point. May be rich-text.
|
publicTransit |
(string) Information about public transit. May be rich-text.
|
publicTransportGettingThere |
(string) Information about public transport getting there. May be rich-text.
|
parking |
(string) Information about the parking situation. May be rich-text.
|
endPointParking |
(string) Information about tour end point parking situation. May be rich-text.
|
literature |
(string) Additional literature about the tour.
|
trustedMaps |
(string) List of trusted / recommended maps. May be rich-text.
|
protectedAreas |
(string) Information about protected areas in and around the tour. May be rich-text.
|
typeOfTour |
(string) The type of tour (loop tour, one way tour, etc).
|
trackType |
(string) The type of track (foot, bike, car).
|
difficulty |
(int|null) 0-2 difficulty rating of the tour.
|
fitness |
(int) 0-5 fitness rating of the tour.
|
technique |
(int) 0-5 technique rating of the tour.
|
experience |
(int) 0-5 experience rating of the tour.
|
landscape |
(int) 0-5 landscape rating of the tour.
|
scenic |
(bool) Scenic
|
geology |
(bool) Geological highlights
|
flora |
(bool) Botanical highlights
|
culture |
(bool) Cultural highlights
|
fauna |
(bool) Fauna highlights
|
healthyClimate |
(bool) Healthy climate
|
refreshmentPoints |
(bool) Refreshment points
|
sights |
(bool) Sights
|
terrain |
(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath',
'nature', 'miscellaneous')
|
signPosts |
(array<Media>) The different Sign Guide Posts of a Tour
|
status
Tour (opening-) status.
Enum:
-
(string) none
-
(string) open
-
(string) closed
|
geometry
(object) GeoJSON data for tour geometries. Does not apply to stage tours
Properties
|
points |
(array) Point data for tours. Does not apply to stage tours.
|
recommendedTimeOfTravel
(object) Information about which months are recommended to travel in.
Properties
january |
(bool) Whether january is a recommended travel time.
|
february |
(bool) Whether february is a recommended travel time.
|
march |
(bool) Whether march is a recommended travel time.
|
april |
(bool) Whether april is a recommended travel time.
|
may |
(bool) Whether may is a recommended travel time.
|
june |
(bool) Whether june is a recommended travel time.
|
july |
(bool) Whether july is a recommended travel time.
|
august |
(bool) Whether august is a recommended travel time.
|
september |
(bool) Whether september is a recommended travel time.
|
october |
(bool) Whether october is a recommended travel time.
|
november |
(bool) Whether november is a recommended travel time.
|
december |
(bool) Whether december is a recommended travel time.
|
|
trackInformation
(array) Array of all GPS Track information.
Array Items
duration |
(int) Estimated duration of the tour in minutes
|
distance |
(int) Distance the tour spans in meters
|
elevationUp |
(float) Meters of elevation upwards.
|
elevationDown |
(float) Meters of elevation downwards.
|
highestPoint |
(float) Highest point of the tour.
|
lowestPoint |
(float) Lowest point of the tour.
|
premiumTourEditHash |
(string|null) Hash that can be used to restore the tour path in the toursprung editor.
See also: MTK.RoutePlanner#loadFromHash.
|
trackType
(string) Type of the track
Enum:
-
(string) bike
-
(string) foot
-
(string) car
|
premiumTourEditType
(string|null) Type of the editing view
Enum:
-
(NULL)
-
(string) car
-
(string) foot
-
(string) bike
|
file
(object|null) GPX / KML Track file associated with this track
Properties
name |
(string) Name of the file.
|
description |
(string) Description of the file. This may be rich-text.
|
path |
(string) Path to the file in the storage.
|
url |
(string) Relative URL to the file.
|
size |
(int) Size of the file in bytes.
|
license
License of the file.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
preview |
(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
|
sizes |
(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
|
relationType |
(string) The type of relation for this file.
|
|
|
tourStageCollections
(array) Array of all tour stage collections.
Array Items
name |
(string)
|
sorting |
(int)
|
stages |
(array<Article>) The tour stages (tour articles with typeOfTour "stage".
|
|
trackDownload
(array) Array of all track downloads in various formats.
Array Items
url |
(string) The public download url.
|
type |
(string) The file type (gpx, kml, etc.).
|
reference
(array) Information about the track being referenced. Could be a single tour or a tour stage collection.
Properties
id |
(string) The id of the object.
|
type |
(string) The model type being referenced.
|
|
|
booking
hotline |
(?string) The phone number of the hotline.
|
hotlineInformation |
(?string) Additional information about the hotline.
|
information |
(?string) Information about the booking provider.
|
requestUrl |
(?string) The request url.
|
url |
(?string) The booking url.
|
voucherUrl |
(?string) Where to buy a voucher.
|
advanceBookingTime |
(?int) How long in advance the ticket must be booked.
|
|
additionalBookingInformation |
(string) Deprecated: Use point.booking.information instead.
|
|
capacity
(object) Information about the capacity (total, current, etc.)
Properties
totalCapacity |
(int) The total capacity as an absolute number.
|
currentLevel |
(int) The current level of visitors.
|
currentLevelType |
(int) If the current level is an absolute number or a percentage.
|
currentLevelUpdatedAt |
(date) When the current level was last updated.
|
currentLevelPercentage |
(int|null) The normalized current level. Is calculated internally.
|
prediction |
(array) The predicted visitors over the course of a week in 3hr steps,
starting at 3am and ending at midnight.
|
predictionFor |
(string) The default scenario the prediction is for (bad weather, etc.)
|
predictionNotice |
(array) Additional information, e.g. about how the weather affects the prediction
values.
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
pivot |
(stdClass|null)
|
casts |
(array<string,string|object>)
|
hidden |
(array<int,string>)
|
fillable |
(array<int,string>)
|
attributes |
(array<string,string>)
|
|
webMediaLinks
(object) A list of web media links.
Array Items
type |
(string) The type of the web link
|
url |
(string) The URL itself pointing ot an external media object
|
title |
(string|null) An optional title for displaying the link
|
description |
(string|null) An optional description for this link
|
sorting |
(int) If multiple links exist for the same type, this sorting is used (the highest first)
|
id |
(string|null) The primary UUID
|
createdAt |
(date|null) The timestamp this item was created at
|
updatedAt |
(date|null) The timestamp this item was last modified at
|
|
sourceSystemInformation
documentation |
(array) A list of source systems this items data is coming from.
|
|
trashed |
(boolean) Indicates whether the item is deleted.
|
|
|
discoveries
(array) Array of articles containing the following properties
Array Items
name |
(string) The name of the article.
|
abstract |
(string) Abstract / Short description(rich text)
|
description |
(string) Description (rich text)
|
type
(string) Type of the article.
Enum:
-
(string) point
-
(string) tour
-
(string) area
|
invisible |
(bool) The invisible/visible state. Similarly to the public/private state an article is only
visible to its own client if it is set to be invisible.
|
tipFamous |
(bool) Tip: Famous
|
tipHighlight |
(bool) Whether this event has been marked as a highlight.
|
tipIdyllic |
(bool) Tip: Idyllic
|
tipNatural |
(bool) Tip: Close to nature & quiet:
|
tipOffTheTrack |
(bool) Tip: Off the track
|
tipOnlyHere |
(bool) Tip: Only exists here
|
tipPopular |
(bool) Tip: Gladly visited
|
tipTypicalForRegion |
(bool) Tip: Typical for the region
|
currentInformation |
(string) Current information about this article.
|
apiVersion |
(int)
|
author |
(string) Display name of author for this item.
|
longitude |
(?float)
|
latitude |
(?float)
|
copyright |
(string|null) The holder of the copyright.
|
sourceInformationLink |
(string|null) Link to information about the source of the item.
|
license
(string|null) License of the item or NULL if no license set.
Enum:
-
(string) none
-
(string) community
-
(string) cc-zero
-
(string) cc-by
-
(string) cc-sa
-
(string) cc-by-sa
-
(string) cc-by-nc
-
(string) cc-by-nc-sa
-
(string) cc-by-nd
-
(string) cc-by-nc-nd
|
highlight |
(bool) Whether this event has been marked as a highlight.
|
locale |
(string) The current language of the category
|
createdAt |
The date at which the article was created. |
updatedAt |
The date at which the article was last updated. |
primaryCategory
(object) The primary category.
Properties
name |
(string) Name of the category.
|
nameWithParents |
(string) Name of the category including all of it's parents. The names of parents
and children are separated by the character » .
|
rootline |
(array) All category ids from the root up to this category
|
rootlineNames |
(array) All category names from the root up to this category
|
invisible |
(bool) Whether the category is currently invisible.
|
type
Type of the category.
Enum:
-
(string) root
-
(string) point
-
(string) event
-
(string) tour
-
(string) event_host
-
(string) area
-
(string) city
|
fieldGroupsGeneral
(array) Array of the general field groups that belong to the category directly (without inheritance)
Array Items
name |
(string) Name of the group.
|
sorting |
(int) Sorting of this group among other groups. Lower numbers will appear
first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the group is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this group.
|
icon |
(string)
|
description |
(string) The user facing description.
|
showInMenu |
(bool) If the group should be listed as a sub-route of the detail-information-section.
|
tags |
(array) Tags can be added to flag field groups for special treatment. This can be a
a different displaying, no displaying, etc.
|
fieldSets
(array) Array of field sets belonging to this group.
Array Items
name |
(string) Name of the field set.
|
replicatable |
(bool) Whether this field can contain multiple values. If a field is marked as replicable then
the user can simply add new values by replicating the field over and over again.
|
replicationHeadlineToken |
(string|null) Token to build a numbered headline for replication instances.
|
sorting |
(int) Sorting of this set among other sets in the same group.
Lower numbers will appear first, higher numbers later.
|
isGenerallyApplicable |
(bool) Whether the set is generally applicable. If it is generally
applicable then it will be displayed to all clients. If not, then each
client has to be whitelisted in order to see this set.
|
customFaq |
(bool) With this setting, the field set will always offer an FAQ item with
custom question (and answer).
|
fields
(array) Array of fields belonging to this set.
Array Items
name |
(string) Name of the field.
|
description |
(string|null) An editor-facing description.
|
icon |
(string) Icon for the particular field.
|
type |
(string) Type of the field. This can be one of the following: input , textarea ,
select , check , radio , upload , help_text .
|
sorting |
(int) The sorting index of this field among other fields in it's set.
|
configuration |
(stdClass) Configuration of the field. This may differ from field to field.
|
tags |
< | | | | | |