APIv1 Documentation

Authentication

A user is authenticated with the API by providing their API key. The API Key can be provided by the following 2 methods:

Using Header (recommended)

The header Authorization: Bearer-Token [TOKEN] may be set in order to authenticate a user.

Using GET-parameter

For easier discovery in the Browser and for environments, where a Authorization header cannot be used (e.g. When the page is already using the header for Basic-Auth) a request may be performed by using the parameter `&api_token=[TOKEN]`

Language

The default language of the system is german. This means that if no parameter is specified german records will be returned and german language labels.

Valid languages are the following:

Record Language

The record language can be changed by providing the &language=[LANGUAGE] GET-Parameter. This will set the language for all retrieved and saved records.

Note however, that the fallback language is german. Thus if you request detailed information about a certain entity in a language that it is not available in (say &language=foobar) then the german record will be returned.

Message Wrapper

Every API-Response (no matter if successful or not) will be wrapped in a common wrapper containing some meta-data and the complete payload.

All properties starting with an underscore contain meta information about the request.

Links

The _links property contains URLs of other API-Endpoints that might be relevant to the developer issuing the current request.

If a List view is being requested the links nextPage and previousPage will contain URLs to the next / previous page in the paginated result list.

Attributes

The _attributes relays the properties given to the endpoint (via GET-Parameter or POST-Body) back to the requester. This can be useful when debugging a request in order to ensure the server has correctly received the request.

Additionally some properties may be populated with sane defaults or additional meta data (such as _attributes.pagination).

Errors

The _errors attribute contains information about errors that occurred during execution. Most (but not all) errors result in no payload being present.

Every error contains the following properties:

Warnings

The _warnings attribute contains warnings about the current request. These warnings are meant as hints to the developer, not for user facing output.

Payload

The payload property contains the data returned by the endpoint or null if the endpoint does not return any data.


{
    "_links": {
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1",
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.links": "GET api/v1/article/{article}/links",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files",
        "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
        "previousPage": null,
        "nextPage": "http://toubiz.local/api/v1/article?api_token=admin_token&invisible=0&private=0&pagination[page]=2"
    },
    "_warning": [
        "No page number given. Assuming first page. You can set a page by using the pagination[page] parameter.",
        "No page size given. Assuming default page size of 10. Use the parameter pagination[pageSize] to supply a custom page size."
    ],
    "_attributes": {
        "pagination": {
            "pageSize": 10,
            "page": 1,
            "total": 294,
            "lastPage": 30
        }
    },
    "_errors": [],
    "payload": [ ... ]
}
                

1.16.0

Added

Changed

1.15.0

Fixed

Added

1.14.0

Added

Deprecated

1.13.1

Changed

1.13.0

Added

Changed

1.12.0

Added

Changed

1.11.4

Added

1.11.2

Added

Deprecated

1.11.1

Added

1.11.0

Changed

1.10.5

Removed

1.10.4

Changed

1.10.2

Added

Changed

Removed

1.10.1

Changes

Changes since 1.1.0 to 1.10.0

This time we provide a list of changes since 2020-07-01.

The following request and response parameters are the main changes between these releases. Minor changes are not listed and should not be breaking. Please refer to the current API documentation for a more detailed description.

2020-W27

2020-W25

2019-W50

2019-W49

2019-W46

2019-W44

2019-W43

2019-W42

2019-W40

2019-W39

2019-W37

Endpoints

docs.json

GET api/v1

Home view: Lists all endpoints with their documentation as JSON.

Examples

`$ curl -X GET http://localhost:8000/api/v1?api_token=TOKEN`

docs.html

GET api/v1/docs

Docs view: Lists all endpoints with their documentation as HTML.

article.index

GET api/v1/article

Lists all articles visible to the user By default invisible and unlicensed articles are hidden and can be enabled using the invisible=1 and unlicensed=1 request parameters.

Attributes

include[]=permissions

Includes the permission details of the article if supplied

include[]=languages

Includes the language details of the article if supplied

include[]=mainImage

Includes the main image of the article if supplied

include[]=distance

Includes the distance to the requested coordinates. Requires the location filter.

include[]=awards

Includes the currently valid awards with minimal award blueprint and award set data.

include[]=externalIds

Also includes the ids from other services for this article

include[]=openingTimes

Also includes the opening times definition. Only for points.

include[]=tourStages

Also includes the stage information for tours.

include[]=capacity

Also includes the capacity information (total, current, etc.).

include[]=covidCasesPer100k

Also includes the Covid-19 cases on average over 7 days per 100.000 people.

sizes

Specifies size classes to generate for the image where the key specifies the names of the size class and the value the size to generate. This can either be a single number, indicating the width of the image or a string containing width & height separated with an x. A request containing ?sizes[thumb]=64x64&sizes[small]=200&sizes[large]=1600 will generate these 3 sizes under the mainImage.sizes key.

minimal=1

Returns an un-paginated object of id => name for all results.

withAggregates=1

Return aggregation numbers for the results.

withResults=0

(default: 1) Suppress the actual results.

applyChannelToQuery
sorting

Allows to sort article list using allowed properties and sort directions: ascending (asc), descending (desc).

The following attributes may be provided:

  • sorting[property]: The property by which the result should be sorted. Defaults to createdAt
  • sorting[direction]: Direction of the sorting. Defaults to asc.
Random Sorting

To use random sorting you may set sorting[property] to random. If sorting[seed] is set then this seed will be used in order to get a reproducible

search

Adds searching capabilities.

filter[category]

Filters articles to only include those that are associated to the primary category with the given id(s).

This property can either contain a comma-separated string of category ids or an array of category ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[category][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/article?filter[category]=12,14
filter[categoryWithSecondary]

Filters articles to only include those that are associated to a category (primary or secondary) with the given id(s).

This property can either contain a comma-separated string of category ids or an array of category ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[categoryWithSecondary][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/article?filter[categoryWithSecondary]=12,14
filter[categoryTypes]

Filters articles to only include those that are associated to the primary category of a certain type.

This property can either contain a comma-separated string of category ids or an array of category types.

Examples

$ curl http://toubiz.local/api/v1/article?filter[categoryTypes][0]=area&filter[categoryTypes][1]=city
$ curl http://toubiz.local/api/v1/article?filter[categoryTypes]=area,city
filter[element]

Filters the articles to only include those matching the given element.

Examples

{ filter: { element: 'gastronomy' } }
filter[typeOfTour]

Filters articles to only include those that are associated to the primary category with the given id(s).

This property can either contain a comma-separated string of category ids or an array of category ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[typeOfTour]=stages_tour
filter[excludeCategory]

Excludes articles that have the categories with the given ids or a child as primary categories.

On its own this filter is not incredibly useful, but it can be used in combination with filter[category] in order to ignore certain subtrees of a larger category tree.

filter[secondaryCategory]

Filters articles to only include those that are associated to the secondary category with the given id(s).

This property can either contain a comma-separated string of category ids or an array of category ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[secondaryCategory][0]=12&filter[secondaryCategory][1]=14
$ curl http://toubiz.local/api/v1/article?filter[secondaryCategory]=12,14
filter[createdBy]

Allows filtering for the creator of an article.

This filter can be specified in one of the following formats if multiple users are filtered for:

  • Array of ids
  • Comma separated string.
filter[location]

Allows filtering for articles by their location.

This property must always be specified as 3 sub-properties:

  • filter[location][latitude]
  • filter[location][longitude]
  • filter[location][radiusMeters].
filter[type]

Filters articles by their type.

The following types exist:

  • tour
  • point
  • event_host.

Examples

curl http://toubiz.local/api/v1/article?filter[type]=tour,area,point
$ curl http://toubiz.local/api/v1/article?filter[type][0]=tour&filter[type][1]=area
filterItemType
filter[categoryType]

Filters articles to only includes those who have a category with the given category type. This search includes primary- and secondary categories.

The following category types exist:

  • point
  • tour
  • event
  • event_host.

If you want to search for the article type use filter[type].

Examples

curl http://toubiz.local/api/v1/article?filter[categoryType]=point
filter[updatedBefore]

Filters the articles to only return those that have been edited before the given timestamp.

Use in combination with filter[updatedAfter] in order to fetch articles that have been edited in a certain time range.

Examples

curl http://toubiz.local/api/v1/article?filter[updatedBefore]=2018-01-01
curl http://toubiz.local/api/v1/article?filter[updatedBefore]=2018-01-01T00:00:00
filter[updatedAfter]

Filters for articles that have been edited since the given timestamp.

Use in combination with filter[updatedAfter] in order to fetch articles that have been edited in a certain time range.

Examples

curl http://toubiz.local/api/v1/article?filter[updatedAfter]=2018-08-01
curl http://toubiz.local/api/v1/article?filter[updatedAfter]=2018-08-01T00:12:00
filter[inCollection]

Filter for articles that are in the given collection with the given id.

Examples

{ "filter": { "inCollection": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed" } }
filter[area]

Filter for articles that are in the areas with the given ids.

Examples

{ "filter": { "area": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed" } }
{ "filter": { "area": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed,9d6b82a7-a107-4cbb-b9ba-ca84e04eb2ed" } }
{ "filter": { "area": { "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed", "9d6b82a7-a107-4cbb-b9ba-ca84e04eb2ed" } } }
filter[city]

Filter for articles that are connected to cities with the given ids.

Examples

{ "filter": { "city": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed" } }
{ "filter": { "city": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed,9d6b82a7-a107-4cbb-b9ba-ca84e04eb2ed" } }
{ "filter": { "city": { "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed", "9d6b82a7-a107-4cbb-b9ba-ca84e04eb2ed" } } }
filter[notInCollection]

Filter for articles that are not in the given collection with the given id.

This is the opposite of filter[inCollection].

Examples

{ "filter": { "inCollection": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed" } }
filterExternalId

Filters articles by the externalId(s).

You can give one or multiple externalIds formatted like sourceName:sourceId. E.g.: outdoorActive:12345. This property can either contain a comma-separated string of externalIds or an array of externalIds.

Examples

$ curl http://toubiz.local/api/v1/article?filter[externalId]=sourceName:sourceId
$ curl
http://toubiz.local/api/v1/article?filter[externalId][]=sourceName:sourceId_1&filter[externalId][]=sourceName:sourceId_2
$ curl http://toubiz.local/api/v1/article?filter[externalId]=sourceName:sourceId_1,sourceName:sourceId_2
filterAreaZipCode

Filters for areas that contain the given zip code(s).

Examples

$ curl http://toubiz.local/api/v1/article?filter[areaZipCode]=78120
filter[capacityLevel]

Filters for a maximum capacity level.

Examples

To filter for all articles with a capacity of 50 or lower:
$ curl http://toubiz.local/api/v1/article?filter[capacityLevel][level]=50
filter[id]

Only fetches entities with the given ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[id][0]=...&filter[id][1]=...
filter[excludeId]

Only fetches entities not within the given ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[excludeId][0]=...&filter[excludeId][1]=...
filter[client]

Allows filtering the return value by the client it belongs to.

If multiple clients should be filtered for then the following formats are accepted:

  • array of ids
  • comma separated ids.

The string current can be provided in order to reference the client of the current user.

filter[clientIncludingManaged]

Allows filtering for client to only return entries that belong to the given client or any of it's managed clients. This property can either be set to the id of a client or to the string current if all entries of the current client should be returned.

filter[dynamicFieldValueSelect]

Examples

$ curl http://toubiz.local/api/v1/article
?filter[dynamicFieldValueSelect][BLUEPRINT_UUID][0]=OPTION_UUID
&filter[dynamicFieldValueSelect][BLUEPRINT_UUID][1]=OTHER_OPTION_UUID
unlicensed
invisible

Also include invisible items of the current client in the API response.

By default, only visible items will be returned - set invisible=1 in order to also list the private events that the current user has access to.

filterStrictInvisible
filter[license]

Filters articles by license.

This property can either contain a comma-separated string of licenses or just one license.

Examples

$ curl http://toubiz.local/api/v1/article?filter[license][0]=12&filter[license][1]=14
$ curl http://toubiz.local/api/v1/article?filter[license]=12,14
filter[tag]

Filters for one or more tags that must be present on the article.

If multiple tags are given, then results are guaranteed to have at least one of the tags but not necessarily all of them.

Examples

# Multiple tags
$ curl https://mein.toubiz.de/api/v1/[...]?filter[tag][]=foo&filter[tag][]=bar
# Multiple tags comma-separated
$ curl https://mein.toubiz.de/api/v1/[...]?filter[tag]=foo,bar
# Single tag
$ curl https://mein.toubiz.de/api/v1/[...]?filter[tag]=foo
filter[highlight]

Filter for articles that are marked as highlights.

This property can be set to true or 1 in order to only return highlights. If set to false or 0 then all articles (including highlights & non-highlights) are returned.

filterTip

Response

(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) event_host
  • (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 the article is a highlight.

tipIdyllic

(bool) Tip: Idyllisch

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

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 the article is a highlight.

locale

(string) The current language of the category

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 or not 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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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
name

(string) Name of the client.

url

(string) URL of the clients Website.

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.

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.

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.

price
freeEntry

(bool) Whether or not 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.

priceGroups

(array) Array with Price groups and their defined fields

Array Items
comment

(string) String with a user specified Comment to a price group

title

(string) String with a user specified Title to a price group

priceEntries
Array Items
comment

(string) String with a user specified Comment to a price entry

title

(string) String with a user specified Title to a price entry

eur

(float) User specified value for the price in EUR

chf

(float) User specified value for 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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

endPoint

(string) Information about the end point of the tour. May be rich-text.

startPointGettingThere

(string|null) Information about getting to the starting point of the tour.

endPointToStartPoint

(string) Information about getting from the end point back to the start point.

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.

parking

(string) Information about the 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 or not january is a recommended travel time.

february

(bool) Whether or not february is a recommended travel time.

march

(bool) Whether or not march is a recommended travel time.

april

(bool) Whether or not april is a recommended travel time.

may

(bool) Whether or not may is a recommended travel time.

june

(bool) Whether or not june is a recommended travel time.

july

(bool) Whether or not july is a recommended travel time.

august

(bool) Whether or not august is a recommended travel time.

september

(bool) Whether or not september is a recommended travel time.

october

(bool) Whether or not october is a recommended travel time.

november

(bool) Whether or not november is a recommended travel time.

december

(bool) Whether or not 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.

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.

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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

Examples

$ curl -g -X GET \
    http://toubiz.local/api/v1/article?api_token=TOKEN&pagination[pageSize]=5&filter[primaryCategory]=20ab716a-406c-3bcf-a133-b54b5dcc1e72

{
    "_links": {
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.contactInformation": "GET api/v1/article/{article}/contactInformation",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files",
        "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
        "api.v1.article.permissions": "GET api/v1/article/{article}/permissions",
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1",
        "previousPage": null,
        "nextPage": "http://toubiz.ddev.site/api/v1/article?q=%2Fapi%2Fv1%2Farticle&api_token=%242y%2410%24uWEpfM.YINolDOvThZf6NOGWd0vnp6%2F8Aj9cArpqBf8iE19nGxuTG&pagination[pageSize]=3&filter[category]=20ab716a-406c-3bcf-a133-b54b5dcc1e72&invisible=0&private=0&pagination[page]=2"
    },
    "_warning": [
        "No page number given. Assuming first page. You can set a page by using the pagination[page] parameter.",
        "No page number given. Assuming first page. You can set a page by using the pagination[page] parameter."
    ],
    "_attributes": {
        "q": "/api/v1/article",
        "pagination": {
            "pageSize": 3,
            "page": 1,
            "total": 19,
            "lastPage": 7
        },
        "filter": {
            "category": "20ab716a-406c-3bcf-a133-b54b5dcc1e72"
        }
    },
    "_errors": [],
    "payload": [
        {
            "id": "c86ef64e-6667-3899-ad17-6e9c5f49abe2",
            "name": "Haus Pluto",
            "abstract": "",
            "description": "<p>Das ist ein Test. Wird mein Name in der Revision angezeigt? Auch wenn der User gel\u00f6scht wird?\u00a0</p>\n<p><strong>Das ist ein Test. Wird mein Name in der Revision angezeigt? Auch wenn der User gel\u00f6scht wird?\u00a0</strong></p>\n<p>Das ist ein Test. Wird mein Name in der Revision angezeigt? Auch wenn der User gel\u00f6scht wird?\u00a0</p>",
            "generalInformation": "",
            "type": "point",
            "primaryCategory": {
                "id": "18192c0a-c88d-36e3-8778-bdc5d91bc7f1",
                "name": "Pension",
                "nameWithParents": "\u00dcbernachten \u00bb Gasth\u00f6fe und Pensionen \u00bb Pension",
                "type": "point",
                "invisible": false
            },
            "private": false,
            "invisible": false,
            "updatedAt": "2018-11-05T10:46:06",
            "tipHighlight": false,
            "address": {
                "id": "62858f76-55f6-372c-8c8e-b9744e3eadb3",
                "name": "",
                "nameWithParents": "",
                "type": "",
                "invisible": false
            }
        },
        {
            "id": "c33c065f-9322-382a-acd4-abcdf11f3956",
            "name": "Das Haus f\u00fcr Naturfreunde",
            "abstract": "",
            "description": "",
            "generalInformation": "",
            "type": "point",
            "primaryCategory": {
                "id": "1a041b7b-9dcf-395c-9e06-ffa8f64c0942",
                "name": "Naturfreundehaus",
                "nameWithParents": "\u00dcbernachten \u00bb Sammelunterk\u00fcnfte  \u00bb Naturfreundehaus",
                "type": "point",
                "invisible": false
            },
            "private": false,
            "invisible": false,
            "updatedAt": "2018-09-19T14:36:30",
            "tipHighlight": false,
            "address": {
                "id": "73188077-978c-3cf1-9038-6cc4f6e0d310",
                "name": "LIS 6",
                "nameWithParents": "",
                "type": "",
                "invisible": false
            }
        },
        {
            "id": "98bf6eb8-e7d0-3ed7-a9b9-b15305ad8e57",
            "name": "Merkmals Typ Test",
            "abstract": "",
            "description": "",
            "generalInformation": "",
            "type": "point",
            "primaryCategory": {
                "id": "1d27e9c6-63bc-3e7c-9068-5db51df44808",
                "name": "Ferienhaus",
                "nameWithParents": "\u00dcbernachten \u00bb Ferienwohnungen/-h\u00e4user \u00bb Ferienhaus",
                "type": "point",
                "invisible": false
            },
            "private": false,
            "invisible": false,
            "updatedAt": "2018-10-23T08:22:32",
            "tipHighlight": false,
            "address": {
                "id": "bbd44950-113d-3b21-a518-343b66d5f88f",
                "name": "Merkmals Typ Test",
                "nameWithParents": "",
                "type": "",
                "invisible": false
            }
        }
    ]
}

article.update

PUT api/v1/article/{article}

Updates an existing article in the database. The data structure that must be given as POST Body is the same as for the store route.

Beware: changing primaryCategory may cause losing all fieldValues which already have been set, only fields which exist in both (old and new) primaryCategory are kept. If fieldValues are set in the current request, only these ones are considered to be stored. All others will be discarded.

Attributes

An article that is being created and edited.

name

(string) The name of the article.

abstract

(string) Abstract / Short description(rich text)

description

(string) Description (rich text)

internalProtocol

(string) Internal protocol (only relevant for admins, rich text)

type

(string) Type of the article.

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 the article is a highlight.

tipIdyllic

(bool) Tip: Idyllisch

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

license

(string|null) License of the item or NULL if no license set.

currentInformation

(string) Current information about this article.

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.

primaryCategory

Associates a primary category with the article. The given data can either be a single id or an object containing the id of the category that should be associated.

Both of the following are valid formats:

{ "primaryCategory": "00632526-a779-41a2-9ffa-f7987de6d514" }
{ "primaryCategory": { "id": "00632526-a779-41a2-9ffa-f7987de6d514", ... } }
  • NOTE: When specifying an object all properties but the id will be ignored.
  • NOTE: The given category must be of the same type as the article.
  • NOTE: The given category must be a leaf node on the category tree.
client

Associates a client with the article. The client can either be specified using a single id or an object that contains the id as a property. Therefor both of the following formats are valid:.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }
  • NOTE: If an object is passed all properties but the id will be ignored.
fieldValues

Interprets the fieldValues attribute as associative array using the field id as a key and an array of values as value. The values for the various dynamic field types can be different. The following is a list of the most common dynamic field types and their value structure:

  • text inputs & textareas: The text to save is in the text property
  • checkboxes: The indexes of the selected options are in an array called selected. These indexes reference the configured options on the field.
  • select fields & radio buttons: The index of the selected option is in the property selected
  • file upload: The file property can contain one of the following:
    1. A multipart/form-data file upload to associate a new file
    2. Properties of a file containing the id property to associate existing files.

Examples

// There are 2 fields:
// 1. test_input is a simple text input.
//    This field can have multiple values (is replicable)
// 2. test_checkbox is a checkbox list with the
//    following options: [ foo, bar, baz ]
{
     "fieldValues": {
         "test_input": [
             { "text": "first value" },
             { "text": "second value" }
         ],
         "test_checkbox": [ { "selected": [ 0, 2 ] } ]
     }
}
tags

Updates the list of tags that are associated with the article. Tags are passed using an array of strings.

Examples

{
     "tags": [ "foo", "bar", "baz" ],
}
locationIdentifier
capacity
externalIds

Adds external ids to an item using a service->value syntax. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "12345-value",
         "my-other-external-service": "foo-54321"
     }
}
secondaryCategories

Associates secondary categories with the article. The items of the given array can either be a single id or objects containing the id of the category that should be associated.

Both of the following are valid formats:

{ "secondaryCategories":
    [ "00632526-a779-41a2-9ffa-f7987de6d514", "00eeb118-021f-45fc-be68-e541fbdc4ebb" ]
}
{ "secondaryCategories": [
  { "id": "00632526-a779-41a2-9ffa-f7987de6d514" },
  { "id": "00eeb118-021f-45fc-be68-e541fbdc4ebb"  }
] }
  • NOTE: When specifying an object all properties but the id will be ignored.
  • NOTE: The given category must be a leaf node on the category tree.
point

Saves point specific attributes for the article. If the value null is passed then all point specific attributes are deleted.

Properties

Special attributes for points.

gettingThere

(string) How to get to the point.

price

Allows filling of price information from a simple object.

Examples

{
     "price": {
         "priceComment": "<p>Samstags sind alle Kinder bis 14 Jahre <strong>umsonst</strong></p>",
         "freeEntry": false,
         "priceTable": [
             [ "Personengruppe",                 "Preis"     ],
             [ "Kinder bis 6 Jahre",             "kostenlos" ],
             [ "Kinder bis 14 Jahre",            "7 Euro"    ],
             [ "Erwachsene",                     "15 Euro"   ],
             [ "Schüler, Studenten und Rentner", "12 Euro"   ],
         ]
     }
}
Properties
freeEntry

(bool) Whether or not 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.

priceGroups
address

Fills the associated address with the given information.

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.

booking

Fills the booking information.

Properties
hotline

(?string) The phone number of the hotline.

hotlineInformation

(?string) Additional information about the hotline.

information

(?string) Information about the booking provider.

url

(?string) The booking url.

voucherUrl

(?string) Where to buy a voucher.

advanceBookingTime

(?int) How long in advance the ticket must be booked.

tour

Saves tour specific attributes for the article. If the value null is passed then all tour specific attributes are deleted.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.

endPoint

(string) Information about the end point of the tour. May be rich-text.

startPointGettingThere

(string|null) Information about getting to the starting point of the tour.

endPointToStartPoint

(string) Information about getting from the end point back to the start point.

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.

parking

(string) Information about the 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.

status

(string) Tour (opening-) status.

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')

calculatedTrackInformation

Updates the relation to calculatedTrackInformation tracks and automatically generates its attributes based on the uploaded file.

geometry
recommendedTimeOfTravel

Sets the recommended time of travel. This attribute may be filled with an object using the month names as keys and booleans as values. If the object is only partially given then only those fields will be updated.

Examples

// Full update
{
     "recommendedTimeOfTravel": {
         "january": true,
         "february": true,
         "march": true,
         "april": true,
         "may": false,
         "june": false,
         "july": false,
         "august": false,
         "september": false,
         "october": false,
         "november": true,
         "december": true,
      }
}
// Partial update: Disable january but leave the rest untouched.
{
     "recommendedTimeOfTravel": {
         "january": false
     }
}
booking

Fills the booking information.

Properties
hotline

(?string) The phone number of the hotline.

hotlineInformation

(?string) Additional information about the hotline.

information

(?string) Information about the booking provider.

url

(?string) The booking url.

voucherUrl

(?string) Where to buy a voucher.

advanceBookingTime

(?int) How long in advance the ticket must be booked.

gpsTracks
Array Items
duration

(int) Estimated duration of the tour in minutes

distance

(int) Distance the tour spans in meters

tourStages

(int) Number of tour stages composing the tour

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.

premiumTourEditType

(string|null) Type of the editing view. Can be one of ['car', 'foot', 'bike']

file

Uploads the given file to base track information on. This attribute can either be a multipart file upload or a string (in order to specify a URL from which to fetch the file).

manualTrackInformation
Properties
duration

(int) Estimated duration of the tour in minutes

distance

(int) Distance the tour spans in meters

tourStages

(int) Number of tour stages composing the tour

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.

premiumTourEditType

(string|null) Type of the editing view. Can be one of ['car', 'foot', 'bike']

tourStageCollections
Properties
name

(string)

sorting

(int)

stages

The stages for this collection. Stages are tours of type "stage".

Examples

{
  "stages": [
    {
      "id": "c77d68b9-a6e9-48cb-a389-5d969df41688"
    },
    {
      "id": "d1ab134e-a53f-4ec3-8d67-d81feb56b130"
    }
  ]
}
area

Saves area specific attributes for the article. If the value null is passed then all area specific attributes are deleted.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

communalLink

(string) Link to the communal homepage.

zipCodes
communalLogo
address

Fills the associated address with the given information.

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.

seo

Update the seo information of the article.

Examples

{
     "seo": {
         "metaDescription": "A super cool hotel",
         "openGraphDescription": "The best hotel in the world",
         "openGraphTitle": "Hotel Mama",
         "noIndex": false,
         "openGraphImage": { "id": 14 }
     }
}
Properties
metaTitle

(string) Contents of the title meta tag

metaDescription

(string) Contents of the description meta tag

canonicalLink

(string) Contents of the canonicalLink

openGraphDescription

(string) Contents of the og:description meta tag

openGraphTitle

(string) Contents of the og:title meta tag.

noIndex

(bool) Whether or not the item should be indexed by search engines. Will add the robots=noindex meta tag if set to true

searchKeywords

(string) Relevant search keywords

openGraphImage

Sets the open graph image from the given attribute. As per File::findFile the image can be either of the following:

  • An multipart uploaded file
  • The id of a file reference
  • An object containing the ID of a file reference.
media

Modifies the media elements associated with the article. The values of the array passed may contain the id property if the media element already exists and should only be updated.

All media elements that are not in the array will be deleted.

Examples

{
     "media": [{
         "id": 42,
         "name": "This was a triumph, I'm making a note here: huge success",
         "main": true,
         "copyright": "Aperture Science",
         "altText": "we do what we must - because we can",
         "description": "for the good of all of us - except the ones who are dead"
     }]
}
Array Items
name

(string) Name of the media element.

description

(string) General description of the image.

altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.

agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.

author

(string) Display name of author for this item.

externalIds

Adds external ids to an item using a service->value syntax. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "12345-value",
         "my-other-external-service": "foo-54321"
     }
}
copyright

(string|null) The holder of the copyright.

license

(string|null) License of the item or NULL if no license set.

sourceInformationLink

(string|null) Link to information about the source of the item.

file

Sets the file that is related to the media element. This may be one of the following:.

  • An object containing the id to reference existing images.
  • A multipart/form-data file upload
  • A string containing a URL from where the file can be downloaded.

If the media element does not have a name set yet then the name will automatically be generated based on the file name.

Examples

{ "file": { "id": 42 } }
{ "file": "https://placehold.it/500x500" }
sizes

Sets the file that is related to the media element. This may be one of the following:.

  • An object containing the id to reference existing images.
  • A multipart/form-data file upload
  • A string containing a URL from where the file can be downloaded.

If the media element does not have a name set yet then the name will automatically be generated based on the file name.

Examples

{ "sizes": { "medium": { "image/jpeg": "https://placehold.it/500x500" } } } }
main

(bool) Set to true if this media is the primary element for the given article/event.

files

Associates files with the article.

  • If a new file should be associated then the key file must contain the multipart/form-data file upload.
  • If an existing file is referenced then the key id must be set.
  • A sring containing an URL from which the file can be downloaded.

A combination of the two cases above can be used to update the file of an existing object.

All files not in the given array will be deleted.

Examples

{
     "files": [{
         "id": 42,
         "name": "Updated name",
         "description": "Updated description"
     }, {
         "file": "https://placehold.it/500x500"
     }]
}
Array Items
name

(string) Name of the file.

description

(string) Description of the file. This may be rich-text.

license

(string) License of the file.

contactInformation

Modifies the contact information related to this article.

Examples

{
     "contactInformation": {
         "twitter": "https://twitter.com/foobar"
     }
}
Properties
contactPersonTitle

(string|null) Title of the contact person.

contactPersonFirstName

(string|null) First name of the contact person.

contactPersonLastName

(string|null) Last name of the contact person.

website

(string|null) URL of the website.

twitter

(string|null) URL of a Twitter profile.

facebook

(string|null) URL of a Facebook page.

flickr

(string|null) URL of a Flickr profile.

youtube

(string|null) URL of a YouTube channel.

instagram

(string|null) URL of an Instagram profile.

vimeo

(string|null) URL of a Vimeo profile.

pinterest

(string|null) URL of a Pinterest profile.

xing

(string|null) URL of a Xing profile.

linkedIn

(string|null) URL of an LinkedIn profile.

wikipedia

(string|null) URL of a Wikipedia article.

blog

(string|null) URL of a blog.

aerial3d
camera360
webcam
youtubeVideo
vimeoVideo
openingTimes

Updates the opening times of the article. This property should only be specified if the article is a point since opening times are specific to points.

Examples

{
     "openingTimes": {
         "mode": "times",
         "definitions": [{
             "type": "regular",
             "openState": "times",
             "comment": "Wochenende",
             "timeRanges": [
                 { "openAt": "09:00", "closeAt": "12:00" },
                 { "openAt": "14:00", "closeAt": "18:00" },
             ],
             "monday": false,
             "tuesday": false,
             "wednesday": false,
             "thursday": false,
             "friday": false,
             "saturday": true,
             "sunday": true,
         }, {
             "type": "seasonal",
             "comment": "Zwischen den Jahren nur Sonntags abends geöffnet",
             "startOn": "2018-12-25",
             "endOn": "2019-01-01",
             "seasonalChildren": [{
                 "openState": "times",
                 "sunday": true,
                 "timeRanges": [{ "openAt": "14:00", "closeAt": "19:00" }],
             }]
         }, {
             "type": "special",
             "openState": "closed"
             "comment": "Heilig abend geschlossen",
             "appliesOn": "2018-12-24"
         }],
     }
}
Properties
mode

The opening times mode. Can be one of the following: always_open, times, open_on_inquiry, public_access, closed_until_further_notice

definitions
Array Items

Opening times, that apply to any Point.This class is also used as a parent to all other types of opening times.

type

(string) Type of the opening times definition. There are 3 major types:

  • regular: These opening times always apply, unless overridden by one of the other types. Regular opening times are defined on a weekday basis.
  • special: These opening times apply on a specific day only. That day is saved in appliesOn
  • seasonal: These opening times apply from a specific day until another specific day. It is important to note, that seasonal opening times are not opening times itself, but a bounded wrapper around other opening times of the type seasonal_children.
openState

(string) The state of the opening times during the defined time frame. Must be one of the following:

  • closed: Always closed
  • always: Always opened
  • times: Opening times / time ranges apply.
title

(string) Title of this opening times definition. DEPRECATED!

startOn

(date|null) The date at which the opening times start applying. Only relevant for seasonal opening times.

endOn

(date|null) The date at which the opening times end applying. Only relevant for seasonal opening times.

appliesOn

(date|null) The exact date at which the opening times apply. Only relevant for special opening times.

monday

(bool) Whether or not the opening times apply on mondays. Only relevant for regular opening times.

tuesday

(bool) Whether or not the opening times apply on $tuesdays. Only relevant for regular opening times.

wednesday

(bool) Whether or not the opening times apply on $wednesdays. Only relevant for regular opening times.

thursday

(bool) Whether or not the opening times apply on $thursdays. Only relevant for regular opening times.

friday

(bool) Whether or not the opening times apply on $fridays. Only relevant for regular opening times.

saturday

(bool) Whether or not the opening times apply on $saturdays. Only relevant for regular opening times.

sunday

(bool) Whether or not the opening times apply on $sundays. Only relevant for regular opening times.

comment

(string) Additional comments about the definition. This may be used to explain why special opening times apply or what exactly the definition represents.

repeatsEveryYear

(bool) Whether the definition should automatically be renewed every year.

timeRanges
Array Items
openAt

(date|null) The time at which the time range starts.

closeAt

(date|null) The time at which the time range ends.

comment

(string) Comment about the time range.

seasonalChildren

Updates the seasonal children of opening times of the type seasonal. These must be opening times definitions in their own right but all of them must have the type seasonal_child.

Examples

{
     "type": "seasonal",
     "startOn": "2018-12-24",
     "endOn": "2019-01-01",
     "comment": "Zwischen den Jahren nur mittags geöffnet.",
     "seasonalChildren": [{
         "type": "seasonal_child",
         "openState": "times",
         "monday": true,
         "tuesday": true,
         "wednesday": true,
         "thursday": true,
         "friday": true,
         "saturday": false,
         "sunday": false,
         "timeRanges": [
             { "openAt": "14:00", "closeAt": "19:00" }
         ]
     }]
}
phoneNumbers

Allows filling of the phone number relation. If a phone number is specified with an id then it is assumed that this phone number already exists in the system and is updated. If not, then a new phone number is created.

All phone numbers that are not in the given data will be deleted.

Examples

{
     "phoneNumbers": [
         {
             "id": 42,
             "type": "phone",
             "primary": true,
             "name": "Zentrale",
             "iso5008": "+49 123 456 78-99"
         },
         {
             "iso5008": "+49 123 456 78-12",
             "name": "Außenstelle"
         }
     ]
}
Array Items

Represents a number that can be used either as a phone number or a fax number.additionally to the raw fields, it accepts setting the components using a ISO5008 formatted number using the virtual property $iso5008.

name

(string) Name of this phone numbers.

type

(string) Type of the phone number. Must be one of the following: phone, fax.

iso5008

Sets the parts of the phone number based on a combined ISO5008 phone number input.

additionalAddress
Array Items
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.

emails

Modifies the relation to email addresses of the article. Every email address must contain the properties name and email. An email address may also contain the property id if an existing address should be updated.

Examples

{
     "emails": [
         { "name": "test", "email": "backoffice@hotel.de" },
         {
             "id": 12,
             "name": "most important address",
             "email": "contact@hotel.de",
             "primary": true
         }
     ]
}
Array Items
id

ID of the E-Mail address if an existing address should be edited.

name

Name of the E-Mail address.

primary

Marks the primary E-Mail address. Only one E-Mail address may be marked as primary.

email

The E-Mail address itself

relatedArticles

Updates the related articles on the current article. The passed value must be a 2-dimensional array that uses the relation type as a key of the first level and articles as keys of the second level.

RelationType can be one of the enum values listed below. Articles can either be passed as simple ids or objects containing ids.

Examples

{
     "relatedArticles": {
         "tourStartPublicTransport": [
             { "id": "6ecfc88a-8684-47d9-9464-881a94fc63f6" }
         ]
     }
}
{
     "relatedArticles": {
         "tourStartPublicTransport": [ "6ecfc88a-8684-47d9-9464-881a94fc63f6" ]
     }
}
Enum:
  • (string) areaHighlights
  • (string) areas
  • (string) discoveries
  • (string) eventRelatedPoints
  • (string) experienceMeetingPoint
  • (string) generic
  • (string) connectedPoints
  • (string) pointGettingThereParking
  • (string) relatedContacts
  • (string) tourAccommodations
  • (string) tourContact
  • (string) tourEndParking
  • (string) tourEndPublicTransport
  • (string) tourInfrastructure
  • (string) tourLodgings
  • (string) tourRefreshmentPoints
  • (string) tourSights
  • (string) tourStages
  • (string) tourStagesVariants
  • (string) tourStartParking
  • (string) tourStartPublicTransport
  • (string) tourSupport
webMediaLinks
Array Items
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)

type

(string) The type of the web link

Enum:
  • (string) aerial3d
  • (string) camera360
  • (string) webcam
  • (string) youtubeVideo
  • (string) vimeoVideo

Examples

$ curl -g \
    -X PATCH \
    -d '{ "name": "updated", "tags": ["foo", "bar", "baz"] }' \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31?api_token=admin_token'

{
  "_links": {
    "api.v1.article.index": "GET api/v1/article",
    "api.v1.article.update": "PUT api/v1/article/{article}",
    "api.v1.article.store": "POST api/v1/article",
    "api.v1.article.destroy": "DELETE api/v1/article/{article}",
    "api.v1.article.show": "GET api/v1/article/{article}",
    "api.v1.article.media": "GET api/v1/article/{article}/media",
    "api.v1.article.tags": "GET api/v1/article/{article}/tags",
    "api.v1.article.contactInformation": "GET api/v1/article/{article}/contactInformation",
    "api.v1.article.emails": "GET api/v1/article/{article}/emails",
    "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
    "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
    "api.v1.article.seo": "GET api/v1/article/{article}/seo",
    "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
    "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
    "api.v1.article.files": "GET api/v1/article/{article}/files",
    "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
    "api.v1.article.permissions": "GET api/v1/article/{article}/permissions",
    "documentation.html": "GET /api/v1/docs",
    "documentation.json": "GET /api/v1"
  },
  "_warning": [],
  "_attributes": {
    "name": "updated",
    "tags": [
        "foo",
        "bar",
        "baz"
    ],
    "q": "/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31"
  },
  "_errors": [],
  "payload": {
    "id": "942b91db-ee64-4f2c-99ae-bdef5f592db7",
    "name": "updated",
    "abstract": "",
    "description": "",
    "generalInformation": "",
    "type": "point",
    "primaryCategory": {
      "id": "886a3ecb-77ce-3b3f-86be-52aaa27383ca",
      "name": "Stadt",
      "nameWithParents": "POI und Infrastruktur \u00bb Ort  \u00bb Stadt",
      "type": "point",
      "invisible": false
    },
    "private": false,
    "invisible": false,
    "updatedAt": "2019-10-17T16:38:31",
    "tipHighlight": false,
    "address": null,
    "secondaryCategories": [],
    "owner": "5bc2fc99-1007-3667-aa20-16afb34cc0d0",
    "internalProtocol": "",
    "emails": [],
    "contactInformation": null,
    "permissions": {
      "read": true,
      "write": true,
      "delete": true
    },
    "fieldValues": { ... },
    "fieldBlueprints": [ ... ],
    "phoneNumbers": [],
    "tags": [
        "foo",
        "bar",
        "baz"
    ],
    "media": [],
    "seo": {
      "id": null,
      "metaDescription": "",
      "noIndex": false,
      "openGraphDescription": "",
      "openGraphTitle": "",
      "openGraphImage": null
    },
    "openingTimes": {
      "mode": "times",
      "definitions": []
    },
    "files": []
  }
}
# NOTE: multipart/form-data file uploads must always use POST.

$ curl -g \
    -X POST \
    -F media[0][file]=@test_image.png \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31?api_token=admin_token'

{
    "_links": { ... },
    "_warning": [],
    "_attributes": { ... },
    "_errors": [],
    "payload": {
        ...
        "media": [
            {
                "id": "c841291e-d6e6-4989-8613-f747a260b9f9",
                "name": "Test image",
                "copyright": "",
                "altText": "",
                "caption": "",
                "preview": {
                    "image/png": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/450x300q75.png",
                    "image/jpeg": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/450x300q75.jpg",
                    "image/webp": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/450x300q75.webp"
                },
                "url": "http://toubiz.local/file/public/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png",
                "hasCustomCaption": false,
                "description": "",
                "main": false,
                "client": 1,
                "fileType": "PNG"
            }
        ],
    }
}

article.store

POST api/v1/article

Creates a new article in the database based on the given attributes. The POST body may contain any of the articles attributes as well as its relations.

This action accepts the same POST body attributes as api.v1.article.update.

Examples

$ curl -g \
    -X POST \
    -d '{ "name": "New article", "primaryCategory": "886a3ecb-77ce-3b3f-86be-52aaa27383ca", "type": "point" }' \
    'http://toubiz.local/api/v1/article?api_token=TOKEN'

{
  "_links": {
    "api.v1.article.index": "GET api/v1/article",
    "api.v1.article.update": "PUT api/v1/article/{article}",
    "api.v1.article.store": "POST api/v1/article",
    "api.v1.article.destroy": "DELETE api/v1/article/{article}",
    "api.v1.article.show": "GET api/v1/article/{article}",
    "api.v1.article.media": "GET api/v1/article/{article}/media",
    "api.v1.article.tags": "GET api/v1/article/{article}/tags",
    "api.v1.article.contactInformation": "GET api/v1/article/{article}/contactInformation",
    "api.v1.article.emails": "GET api/v1/article/{article}/emails",
    "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
    "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
    "api.v1.article.seo": "GET api/v1/article/{article}/seo",
    "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
    "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
    "api.v1.article.files": "GET api/v1/article/{article}/files",
    "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
    "api.v1.article.permissions": "GET api/v1/article/{article}/permissions",
    "documentation.html": "GET /api/v1/docs",
    "documentation.json": "GET /api/v1"
  },
  "_warning": [],
  "_attributes": {
    "name": "New article",
    "primaryCategory": "886a3ecb-77ce-3b3f-86be-52aaa27383ca",
    "type": "point",
    "q": "/api/v1/article"
  },
  "_errors": [],
  "payload": {
    "id": "942b91db-ee64-4f2c-99ae-bdef5f592db7",
    "name": "New article",
    "abstract": "",
    "description": "",
    "generalInformation": "",
    "type": "point",
    "primaryCategory": {
      "id": "886a3ecb-77ce-3b3f-86be-52aaa27383ca",
      "name": "Stadt",
      "nameWithParents": "POI und Infrastruktur \u00bb Ort  \u00bb Stadt",
      "type": "point",
      "invisible": false
    },
    "private": false,
    "invisible": false,
    "updatedAt": "2019-10-17T16:38:31",
    "tipHighlight": false,
    "address": null,
    "secondaryCategories": [],
    "owner": "5bc2fc99-1007-3667-aa20-16afb34cc0d0",
    "internalProtocol": "",
    "emails": [],
    "contactInformation": null,
    "permissions": {
      "read": true,
      "write": true,
      "delete": true
    },
    "fieldValues": { ... },
    "fieldBlueprints": [ ... ],
    "phoneNumbers": [],
    "tags": [],
    "media": [],
    "seo": {
      "id": null,
      "metaDescription": "",
      "noIndex": false,
      "openGraphDescription": "",
      "openGraphTitle": "",
      "openGraphImage": null
    },
    "openingTimes": {
      "mode": "times",
      "definitions": []
    },
    "files": []
  }
}

article.destroy

DELETE api/v1/article/{article}

Delete the specified article.

Examples

$ curl -X DELETE \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31?api_token=TOKEN'

{
  "_links": { ... },
  "_warning": [],
  "_attributes": [],
  "_errors": [],
  "payload": null
}

article.show

GET api/v1/article/{article}

Fetch an article. It is possible to include relational data using the include parameter. This will add an attribute to the response payload that has the same name as the parameter (files for &include=files) that contains the response payload of the corresponding subroutes (e.g. /api/v1/article/[ID]/files).

Attributes

include[]=emails

Also includes the results of the article.emails route with the data

include[]=contactInformation

Also includes the results of the article.contactInformation route with the data

include[]=files

Also includes the results of the article.files route with the data

include[]=fieldValues

Also includes the results of the article.fieldValues route with the data

include[]=fieldBlueprints

Also includes the results of the article.fieldBlueprints route with the data.

include[]=phoneNumbers

Also includes the results of the article.phoneNumbers route with the data

include[]=tags

Also includes the results of the article.tags route with the data

include[]=media

Also includes the results of the article.media route with the data

include[]=seo

Also includes the results of the article.seo route with the data

include[]=languages

Also includes the languages

include[]=collections

Also includes the results of the article.collections route with the data

include[]=externalIds

Also includes the ids from other services for this article

include[]=eventsAtThisLocation

Also includes all events for which this is the location

include[]=nearbyArticles

Also includes all articles that are nearby

include[]=nearbyEvents

Also includes all events for which the location is nearby

include[]=tourStageRelations

Also includes the parent tour and all other stages of the parent tour

include[]=client

Include a minimal client object instead of the id

include[]=awards

Includes the currently valid awards with minimal award blueprint and award set data.

include[]=classifications

Include the awards of type classification given to this articles

include[]=locationIdentifiers

Include the location identifier for this area

Response

emails

Contains the payload of article.emails if include[]=emails was passed.

contactInformation

Contains the payload of article.contactInformation if include[]=contactInformation was passed.

files

Contains the payload of article.files if include[]=files was passed.

fieldValues

Contains the payload of article.fieldValues if include[]=fieldValues was passed.

fieldBlueprints

Contains the payload of article.fieldBlueprints 'if include[]=fieldBlueprints was passed.

phoneNumbers

Contains the payload of article.phoneNumbers if include[]=phoneNumbers was passed.

tags

Contains the payload of article.tags if include[]=tags was passed.

media

Contains the payload of article.media if include[]=media was passed.

seo

Contains the payload of article.seo if include[]=seo was passed.

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) event_host
  • (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 the article is a highlight.

tipIdyllic

(bool) Tip: Idyllisch

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

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 the article is a highlight.

locale

(string) The current entities language identifier.

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 or not 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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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) ID of the client or client object to which the article belongs

Properties
name

(string) Name of the client.

url

(string) URL of the clients Website.

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.

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.

owner

(string) Owner of the client.

defaultMapCenterLatitude

(float) Latitude of default map center.

defaultMapCenterLongitude

(float) Longitude of default map center.

legalClient

(object) The client handling legal matters (Terms of service, etc.)

Properties
name

(string) Name of the client.

url

(string) URL of the clients Website.

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.

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.

defaultLicense
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
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.

price
freeEntry

(bool) Whether or not 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.

priceGroups

(array) Array with Price groups and their defined fields

Array Items
comment

(string) String with a user specified Comment to a price group

title

(string) String with a user specified Title to a price group

priceEntries
Array Items
comment

(string) String with a user specified Comment to a price entry

title

(string) String with a user specified Title to a price entry

eur

(float) User specified value for the price in EUR

chf

(float) User specified value for 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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

endPoint

(string) Information about the end point of the tour. May be rich-text.

startPointGettingThere

(string|null) Information about getting to the starting point of the tour.

endPointToStartPoint

(string) Information about getting from the end point back to the start point.

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.

parking

(string) Information about the 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 or not january is a recommended travel time.

february

(bool) Whether or not february is a recommended travel time.

march

(bool) Whether or not march is a recommended travel time.

april

(bool) Whether or not april is a recommended travel time.

may

(bool) Whether or not may is a recommended travel time.

june

(bool) Whether or not june is a recommended travel time.

july

(bool) Whether or not july is a recommended travel time.

august

(bool) Whether or not august is a recommended travel time.

september

(bool) Whether or not september is a recommended travel time.

october

(bool) Whether or not october is a recommended travel time.

november

(bool) Whether or not november is a recommended travel time.

december

(bool) Whether or not 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.

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.

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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

auditor

(string) The display name of the person who last changed this item.

currentInformation

(string) Current information about this article.

secondaryCategories

(array) Information about the secondary categories of the article.

Array Items
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 or not 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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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>)

languages

(string) All available translations of the current entity.

permissions

(object) The permissions of the current user on this article

Properties
read

(boolean) Read permissions

write

(boolean) Write permissions

delete

(boolean) Delete permissions

eventsAtThisLocation

(array) Events taking place at this location.

Array Items
name

(string) Name of the event.

eventType

(string) Type of the event.

invisible

(bool) Whether this event has been marked as invisible. Invisible events cannot be seen by foreign clients - no matter what.

tipFamous

(bool) Tip: Famous

tipHighlight

(bool) Whether this event has been marked as a highlight.

tipIdyllic

(bool) Tip: Idyllisch

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

type

(string) Type of the event. Must be one of local, regional, multiregional.

intro

(string) Short intro text about the event. May contain rich-text.

mergeDates

(bool) Whether to merge dates of intervals in the frontend.

host

(Article|null) ID of the article set as host.

canceled

(bool) Whether the event is canceled.

onDemand

(bool)

author

(string) Display name of author for this item.

copyright

(string|null) The holder of the copyright.

sourceInformationLink

(string|null) Link to information about the source of the item.

highlight

(bool) Whether this event has been marked as a highlight.

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
location

(array) Article set as location.

Array Items
id

(string) id of the Article set as location

name

(string) name of the Article set as location

updatedAt

The date at which the event was last updated.

firstDate

(object) The first date of the event in YYYY-MM-DD format (or null if none exist).

lastDate

(object) The last date of the event in YYYY-MM-DD format (or null if none exist).

nextDate

(object) The next upcoming date of the event in YYYY-MM-DD format (or null if none exist).

languages

(string[]) List of language in which the event is available. Only present if requested.

permissions

(object) Permissions of the current user on the event. Contains the following properties: read, write, delete, manage. Only present if requested.

preview

(object) Preview image of the event. This is an object that uses the MIME type of the file as a key and an absolute URL to the file as a value. Only present if requested.

category

(Category|null) Main category of the event.

Properties
id

(string) id of the category

name

(string) name of the category

client

(string) id of the client this event belongs to.

locale

(string) The current entities language identifier.

externalIds

(array) The id of this article for a number of external services.

geocoordinates

(array) The geocoordinates of the event.

dateIntervals

Information about the configured date intervals

Array Items

Date intervals define rules for generating dates for the associated event. Dates are automatically generated if the associated interval is saved in the database.The property configuration requires a different format depending on the type of interval that is being configured.

Daily (type = daily)

Defines a date interval on a daily basis such as "every day" or "every 3 days". The interval property defines how many days are in between each date. An interval of 1 means "every day" where as an interval of 4 means "every 4 days".

Monthly (type = monthly)

Defines a date interval on a monthly basis such as "every month" or "every 3 months". The interval property defines how many months are in between each date and the date property defines the date on which the event is every month.

MonthlyDayOfWeek (type = monthly_day_of_week)

Defines a monthly interval that repeats on a given week in the month.Examples for these intervals are "Every first monday of the month" or "Every second to last thursday and friday of the month".

This date interval type expects 2 configuration options to be defined:

  • days: Array of day indexes on which the dates should occur. These indexes start at 0 for sunday ( 1 for monday ).
  • week: Week definition: Defines which week the dates should occur in. Valid values are:
    • first
    • second
    • third
    • second_to_last
    • last Note, that depending on the context second_to_last can be the same as second or third but has a different logic attached to it.

NOTE: The interval property is ignored by this date interval type to prevent unnecessary complexity.

Weekdays (type = weekdays)

On every weekday of the week.This is basically the same as Weekly with predefined days (Monday - Friday). NOTE: In order to reduce complexity this date interval type ignores the interval property.

Weekly (type = weekly)

Defines a weekly date interval. Examples for weekly intervals are the following:.- Every sunday

  • Every second tuesday
  • Monday and friday of every second week

This date interval type requires the following configuration options to be set:

  • days: Array of day indexes defining which day of the week the date should be on. These indexes start at 0 for sunday (1 for monday).
type

(string) Type of the date interval. Can be one of daily, weekdays, weekly, monthly, monthly_day_of_week or yearly.

onDemand

(bool) If dates for this event can be requested.

interval

(int) Interval at which the dates should be defined. For simple intervals such as daily this allows to create dates that skip a number of days/weeks/months to build intervals such as "Every monday of every third week" ( interval=3 )

date

(date|null) Start of the interval. All generated dates are relative to this start date.

end

(date|null) End of the interval. No dates will be generated that are after this date.

startAt

(string|null) The time when the event starts at on every generated date. (HH:mm)

endAt

(string|null) The time when the event ends at on every generated date. (HH:mm)

displayDurationAs

(string) The duration can be displayed as a duration or an end time.

additionalInformation

(string) Additional information about the date.

configuration

(array) Configuration: Different depending on the type of interval (see above).

disabledDates

(array) Array of indexes of generated dates that should be manually disabled. This allows the user to manually de-select a single date in an interval.

bookingUrl

(string|null) The link to an external booking service.

canceled

(bool) All event dates for this interval should explicitly be marked as "canceled".

soldOut

(bool) All event dates for this interval are sold out.

generatedFromId

(string) Date intervals can be exploded into separate single-date intervals. This references the original interval.

humanReadableRepeatRule

(string) A human readable representation of the interval.

repeatRuleName

The type of the repeat rule.

Enum:
  • (string) daily
  • (string) weekdays
  • (string) weekly
  • (string) monthly
  • (string) monthly_day_of_week
  • (string) yearly
  • (string) none
booking
hotline

(?string) The phone number of the hotline.

hotlineInformation

(?string) Additional information about the hotline.

information

(?string) Information about the booking provider.

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.

bookingHotline

(string) Deprecated: Use point.booking.hotlineInformation instead.

bookingUrl

(string) Deprecated: Use point.booking.url instead.

sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31?api_token=admin_token'

{
    "_links": {
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.contactInformation": "GET api/v1/article/{article}/contactInformation",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files",
        "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
        "api.v1.article.permissions": "GET api/v1/article/{article}/permissions",
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1"
    },
    "_warning": [],
    "_attributes": {
        "q": "/api/v1/article/5b223e7b-250a-3379-9183-38d5943b557d"
    },
    "_errors": [],
    "payload": {
        "id": "5b223e7b-250a-3379-9183-38d5943b557d",
        "name": "Testort",
        "abstract": "Cras mattis consectetur purus sit amet fermentum. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.",
        "description": "kjfjeijfiej",
        "generalInformation": "",
        "type": "point",
        "primaryCategory": {
            "id": "886a3ecb-77ce-3b3f-86be-52aaa27383ca",
            "name": "Stadt",
            "nameWithParents": "POI und Infrastruktur \u00bb Ort  \u00bb Stadt",
            "type": "point",
            "invisible": false
        },
        "private": false,
        "invisible": false,
        "updatedAt": "2019-05-13T07:24:37",
        "tipHighlight": false,
        "address": {
            "id": "ea8870ac-8451-3235-b22b-b08deb23a667",
            "name": "",
            "nameWithParents": "",
            "type": "",
            "invisible": false
        },
        "secondaryCategories": [],
        "owner": "5bc2fc99-1007-3667-aa20-16afb34cc0d0",
        "point": {
            "price": {
                "freeEntry": false,
                "priceComment": "",
                "priceTable": [
                    [ "", "", "" ],
                    [ "", "", "" ],
                    [ "", "", "" ]
                ]
            },
            "longitude": 8.0931399999999485,
            "latitude": 47.90455,
            "address": {
                "id": "ea8870ac-8451-3235-b22b-b08deb23a667",
                "name": "",
                "street": "Windeck",
                "streetNumber": "2",
                "zip": "79856",
                "city": "Hinterzarten-Windeck",
                "country": "DE"
            }
        }
    }
}

article.media

GET api/v1/article/{article}/media

Lists all media of the given article. It is possible to access this information with include=media on the show route.

Attributes

sizes

Specifies size classes to generate for the image where the key specifies the names of the size class and the value the size to generate. This can either be a single number, indicating the width of the image or a string containing width & height separated with an x. A request containing ?sizes[thumb]=64x64&sizes[small]=200&sizes[large]=1600 will generate these 3 sizes under the sizes key.

Response

(array) Array of Media objects containing the following properties

Array Items
name

(string) Name of the media element.

description

(string) General description of the image.

altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.

agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.

agreedUsageRightsBy

(User|null) The user who guaranteed the usage rights.

checksum

(string) The checksum of the underlying file.

author

(string) Display name of author for this item.

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
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.

preview

(object) Deprecated, please use sizes. Contains the first size class from sizes for backwards compatibility.

main

(bool) If the media element is fetched from a relation (e.g. Article images) that support the selection of a main image then this property contains that main image state.

client

(integer) ID of the client this media element is associated to.

clientName

(string) Name of the client this media element is associated to.

createdAt

(string) DateTime of this media creation.

updatedAt

(string) Last DateTime of this media update.

uploadedBy

(string) Name of the user who uploaded this media.

fileType

(string) Human readable version of the MIME Type fo the media element.

url

(string) Url to the Image on the server.

colors

(object) Average colors at different positions in the image.

Properties
topleft

(string) Average hex-color of the top-left corner

topright

(string) Average hex-color of the top-right corner

bottomleft

(string) Average hex-color of the bottom-left corner

bottomright

(string) Average hex-color of the bottom-right corner

center

(string) Average hex-color of the center

focusPoint

(object) The focus point which is used to center the image.

Properties
x

(int) The X component of the focus point which is used to center the image.

y

(int) The Y component of the focus point which is used to center the image.

dimensions

(object) Dimensions of the full image Contains width and height properties

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/media?api_token=admin_token&preview=320x240

{
    "_links": {
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1",
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files"
    },
    "_warning": [],
    "_attributes": {
        "preview": "320x240"
    },
    "_errors": [],
    "payload": [
        {
            "id": "30d65e19-5e27-4b60-8803-0905442fc20a",
            "name": "Jenkins 300x300",
            "copyright": "",
            "altText": "",
            "caption": "",
            "preview": {
                "image/png": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/320x240q75.png",
                "image/jpeg": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/320x240q75.jpg",
                "image/webp": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/320x240q75.webp"
            },
            "url": "http://toubiz.local/storage/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png",
            "hasCustomCaption": false,
            "description": "",
            "main": false,
            "client": 1,
            "fileType": "PNG"
        }
    ]
}

article.tags

GET api/v1/article/{article}/tags

article.contactInformation

GET api/v1/article/{article}/contactInformation

Displays the contact information for the article.

Response

contactPersonTitle

(string|null) Title of the contact person.

contactPersonFirstName

(string|null) First name of the contact person.

contactPersonLastName

(string|null) Last name of the contact person.

website

(string|null) URL of the website.

twitter

(string|null) URL of a Twitter profile.

facebook

(string|null) URL of a Facebook page.

flickr

(string|null) URL of a Flickr profile.

youtube

(string|null) URL of a YouTube channel.

instagram

(string|null) URL of an Instagram profile.

vimeo

(string|null) URL of a Vimeo profile.

pinterest

(string|null) URL of a Pinterest profile.

xing

(string|null) URL of a Xing profile.

linkedIn

(string|null) URL of an LinkedIn profile.

wikipedia

(string|null) URL of a Wikipedia article.

blog

(string|null) URL of a blog.

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

locale

(string)

aerial3d

(string) DEPRECATED, use webMediaLinks

camera360

(string) DEPRECATED, use webMediaLinks

webcam

(string) DEPRECATED, use webMediaLinks

youtubeVideo

(string) DEPRECATED, use webMediaLinks

vimeoVideo

(string) DEPRECATED, use webMediaLinks

article.emails

GET api/v1/article/{article}/emails

Displays all emails associated to an article. It is possible to access this information with include=emails on the show route.

Response

(array) Array of E-Mail adresses containing the following properties

Array Items
name

(string) Name of the E-Mail address.

email

(string) E-Mail address itself.

primary

(bool) Whether this is the primary Address. Only one E-Mail address should be marked primary per article.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/emails?api_token=admin_token'

{
    "_links": {
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.contactInformation": "GET api/v1/article/{article}/contactInformation",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files",
        "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
        "api.v1.article.permissions": "GET api/v1/article/{article}/permissions",
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1"
    },
    "_warning": [],
    "_attributes": {
        "q": "/api/v1/article/740a127e-61ee-37c0-abc7-756fd80333f8/emails"
    },
    "_errors": [],
    "payload": [
        {
            "id": "bb5a2982-def7-31c2-901c-0e4fb19b5b2f",
            "name": "General Information",
            "email": "info@test.com",
            "primary": true
        },
        {
            "id": "a0133f7d-6634-4b94-8f74-5a41a41ff73f",
            "name": "Tour specific questions",
            "email": "tours@test.com",
            "primary": false
        },
    ]
}

article.fieldBlueprints

GET api/v1/article/{article}/fieldBlueprints

Some data is not defined directly on a model - rather in what is called a 'dynamic field' which is displayed to the user depending on the context of the article and the user. This allows us to display some fields only to some users or some, very specific field only for articles in very specific categories.

This endpoint returns the field blueprints: The definitions of which dynamic fields are available for the current article. This endpoint does not yet contain any values which have been entered into these fields: These are available using the article.fieldValues endpoint.

Response

(array) Array of dynamic field blueprints keyed by their id containing the following properties

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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>)

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/fieldBlueprints?api_token=TOKEN'

{
  "_links": {},
  "_warning": [],
  "_attributes": [],
  "_errors": [],
  "payload": [
    {
      "id": "97cd7a3c-b532-4cb0-8625-20dc32ed2605",
      "name": "Gastro Details",
      "isGenerallyApplicable": true,
      "sorting": 0,
      "fieldSets": [
        {
          "id": "920fada4-4487-47bb-aec4-f41abc3ddb8b",
          "name": "Barrierefreiheit",
          "isGenerallyApplicable": true,
          "sorting": 0,
          "replicatable": false,
          "icon": null,
          "fields": [
            {
              "id": "8aab102d-9538-3994-9871-63c1c73124c4",
              "name": "Sanitärräume/WC's: Sitzhöhe des WC-Beckens",
              "type": "input",
              "sorting": 37,
              "configuration": {
                "type": "number",
                "uploadType": "",
                "placeholder": "cm"
              }
            },
            {
              "id": "e46d6a10-0864-3ed9-8cfb-99769344c331",
              "name": "Personal & Sonstiges",
              "type": "check",
              "sorting": 38,
              "configuration": {
                "type": "text",
                "options": [
                  "Gebärdensprache wird verstanden",
                  "Personal im Umgang mit gehörlosen/hörgeschädigten Personen geschult",
                  "Führungen in Begleitung eines Gebärdensprachdolmetschers",
                  "Akustische Verstärkungsanlagen (Induktionsschleife) bei Veranstaltungen, Führungen, an Kassen, Infostellen",
                  "Gedruckte Informationen in Großschrift/Blindenschrift/kontrastreich",
                  "Hörkassetten, Audioguides, sonstige akustische Medien",
                  "Infotafeln/Wegweiser in Blindenschrift/Relief/Großschrift/kontrastreich",
                  "Personal im Umgang mit blinden Menschen geschult",
                  "Spezielle Führungen für blinde/sehbehinderte Menschen",
                  "Führhunde erlaubt",
                  "Akustische Alarmsignale",
                  "Barrierefreier Nahverkehrsanschluss (Niederflurbusse, optische und akustische Anzeigen)",
                  "Dolmetscherdienste und/oder besondere optische Informationen für gehörlose Menschen bei Veranstaltungen",
                  "Dienstleistungen für Sehbehinderte",
                  "Dienstleistungen für Gehörlose und Schwerhörige",
                  "Rollstuhlverleih",
                  "Hilfen für Menschen mit Lernbehinderung"
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

article.fieldValues

GET api/v1/article/{article}/fieldValues

Contains the values of the dynamic fields associated with the current article. The payload is an object which uses the id of the blueprint as a key and an array of field values as the value.

It is possible to access this information with include=fieldValues on the article.show route.

Response

(array) Array of dynamic field values keyed by their id containing the following properties

Array Items
value

(object) The value of the field. This object may have different properties depending on the field type.

Properties
selected

(int|int[]) Index of the selected option for select and radio fields, array of selected indexes for checkbox field

text

(string) Contents of text inputs & textareas

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/fieldValues?api_token=TOKEN'

{
    "_links": { ... },
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "heightOfToilet": [{
            "value": { "text": "50" }
        }],
        "staffAndVarious": [{
            "value": { "selected": [ 0, 2, 4 ] }
        }]
    }
}

article.seo

GET api/v1/article/{article}/seo

List of all SEO information associated with the given article. It is possible to access this information with include=seo on the show route.

Response

metaTitle

(string) Contents of the title meta tag

metaDescription

(string) Contents of the description meta tag

canonicalLink

(string) Contents of the canonicalLink

openGraphDescription

(string) Contents of the og:description meta tag

openGraphTitle

(string) Contents of the og:title meta tag.

noIndex

(bool) Whether or not the item should be indexed by search engines. Will add the robots=noindex meta tag if set to true

searchKeywords

(string) Relevant search keywords

openGraphImage

(File|null) Contents of the og:image meta tag

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.

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.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/seo?api_token=admin_token'

  {
      "_links": { ... },
      "_warning": [],
      "_attributes": [],
      "_errors": [],
      "payload": {
          "id": "fff2a63a-b323-4828-9b61-f9fcb426d565",
          "metaDescription": "",
          "noIndex": false,
          "openGraphDescription": "",
          "openGraphImage": null,
          "openGraphTitle": ""
      }
  }⏎

article.openingTimes

GET api/v1/article/{article}/openingTimes

Get all types of opening times for an article. The article needs to be a point to be able to use this endpoint.

Response

mode

(string) Modes of the opening times. This can be one of the following:

  • always_open: This location is always opened (e.g. BBQ-spot).
  • open_on_inquiry: There are no fixed opening times - the user has to ask in order for the location to open for them.
  • times: There are fixed opening times. In this mode the times will be defined using the related opening times definitions.
  • public_access: This place is open to public visitors.
  • closed_until_further_notice: Permanently closed. Changes to opening times may occur in the future.
definitions

(array) The definitions (rules) for opening times.

Array Items
seasonalChildren

(array<OpeningTimesDefinition>)

type

(string) Type of the opening times definition. There are 3 major types:

  • regular: These opening times always apply, unless overridden by one of the other types. Regular opening times are defined on a weekday basis.
  • special: These opening times apply on a specific day only. That day is saved in appliesOn
  • seasonal: These opening times apply from a specific day until another specific day. It is important to note, that seasonal opening times are not opening times itself, but a bounded wrapper around other opening times of the type seasonal_children.
openState

(string) The state of the opening times during the defined time frame. Must be one of the following:

  • closed: Always closed
  • always: Always opened
  • times: Opening times / time ranges apply.
title

(string) Title of this opening times definition. DEPRECATED!

startOn

(date|null) The date at which the opening times start applying. Only relevant for seasonal opening times.

endOn

(date|null) The date at which the opening times end applying. Only relevant for seasonal opening times.

appliesOn

(date|null) The exact date at which the opening times apply. Only relevant for special opening times.

monday

(bool) Whether or not the opening times apply on mondays. Only relevant for regular opening times.

tuesday

(bool) Whether or not the opening times apply on $tuesdays. Only relevant for regular opening times.

wednesday

(bool) Whether or not the opening times apply on $wednesdays. Only relevant for regular opening times.

thursday

(bool) Whether or not the opening times apply on $thursdays. Only relevant for regular opening times.

friday

(bool) Whether or not the opening times apply on $fridays. Only relevant for regular opening times.

saturday

(bool) Whether or not the opening times apply on $saturdays. Only relevant for regular opening times.

sunday

(bool) Whether or not the opening times apply on $sundays. Only relevant for regular opening times.

comment

(string) Additional comments about the definition. This may be used to explain why special opening times apply or what exactly the definition represents.

timeRanges

(array<TimeRange>) Time ranges during which the location is open (only for openState times).

Array Items
openAt

(date|null) The time at which the time range starts.

closeAt

(date|null) The time at which the time range ends.

comment

(string) Comment about the time range.

Examples

$ curl -X \
    GET 'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/openingTimes?api_token=TOKEN'

  {
      "_links": { ... },
      "_warning": [],
      "_attributes": [],
      "_errors": [],
      "payload": {
          "mode": "times",
          "definitions": [{
              "id": "412c2c18-a4d8-40f5-aa1b-9a9070222d7e",
              "comment": "",
              "type": "regular",
              "openState": "times",
              "title": "",
              "timeRanges": [{
                  "id": "18e3c17a-f92f-4e5e-adcc-3cb71bc392af",
                  "openAt": "09:00",
                   "closeAt": "12:00",
                   "comment": "Morgens"
              },{
                  "id": "4312ab88-314b-4431-a81e-efeb9882a6e4",
                  "openAt": "14:00",
                  "closeAt": "17:00",
                  "comment": "Mittags"
              }],
              "monday": true,
              "tuesday": true,
              "wednesday": true,
              "thursday": true,
              "friday": true,
              "saturday": false,
              "sunday": false
          }, {
              "id": "acc72afd-af45-468b-a8d3-981f06271bfd",
              "comment": "",
              "type": "special",
              "openState": "closed",
              "title": "",
              "appliesOn": "2018-06-05"
          }]
      }
  }

article.phoneNumbers

GET api/v1/article/{article}/phoneNumbers

Fetches the phone numbers that are associated with an article.

Response

(array) Array of phone numbers containing the following properties

Array Items
name

(string) Name of this phone numbers.

type

(string) Type of the phone number. Must be one of the following: phone, fax.

iso5008

(string)

primary

Deprecated, don't use it!

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/phoneNumbers?api_token=admin_token'

{
    "_links": { ... },
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": [
        {
            "id": "a63a4ab1-e1ae-4572-8d5a-76f0e1e799a9",
            "name": "Primary number",
            "type": "phone",
            "primary": true,
            "iso5008": "+49 12345 6890"
        },
        {
            "id": "81efceac-4689-47ec-90de-763997a2d451",
            "name": "Secondary number",
            "type": "phone",
            "primary": false,
            "iso5008": "+49 3456 789"
        },
        {
            "id": "2808b3d7-5aff-4a20-8ffa-a12f1d87af4a",
            "name": "Fax",
            "type": "fax",
            "primary": true,
            "iso5008": "+49 1234 8976"
        }
    ]
}

article.files

GET api/v1/article/{article}/files

Lists all files of the given article.

Response

(array) Array of files containing the following properties

Array Items
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.

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.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/files?api_token=TOKEN'

{
    "_links": { ... },
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": [
        {
            "id": "30d65e19-5e27-4b60-8803-0905442fc20a",
            "name": "index.pdf",
            "description": "",
            "url": "https://toubiz.local/storage/article/18d1f95ba1fdaf717edcca80d577ebb6__5baa054503436.pdf",
            "preview": {
                "image/png": "/dist/img/filetypes/pdf.png"
            }
        }
    ]
}

article.additionalAddress

GET api/v1/article/{article}/additionalAddress

Fetches the additional address that are associated with an article.

Response

(array) Array of addressses containing the following properties

Array Items
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.

article.relatedArticles

GET api/v1/article/{article}/relatedArticles

Fetches the articles related to the current article as an object that uses the relation type as a key and the relations as a value. This data is only available using include[]=relatedArticles on the article.show route.

Attributes

include[]=permissions

Includes the permission details of the article if supplied

include[]=languages

Includes the language details of the article if supplied

include[]=mainImage

Includes the main image of the article if supplied

include[]=externalIds

Also includes the ids from other services for this article

Response

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) event_host
  • (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 the article is a highlight.

tipIdyllic

(bool) Tip: Idyllisch

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

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 the article is a highlight.

locale

(string) The current language of the category

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 or not 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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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
name

(string) Name of the client.

url

(string) URL of the clients Website.

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.

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.

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.

price
freeEntry

(bool) Whether or not 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.

priceGroups

(array) Array with Price groups and their defined fields

Array Items
comment

(string) String with a user specified Comment to a price group

title

(string) String with a user specified Title to a price group

priceEntries
Array Items
comment

(string) String with a user specified Comment to a price entry

title

(string) String with a user specified Title to a price entry

eur

(float) User specified value for the price in EUR

chf

(float) User specified value for 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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

endPoint

(string) Information about the end point of the tour. May be rich-text.

startPointGettingThere

(string|null) Information about getting to the starting point of the tour.

endPointToStartPoint

(string) Information about getting from the end point back to the start point.

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.

parking

(string) Information about the 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 or not january is a recommended travel time.

february

(bool) Whether or not february is a recommended travel time.

march

(bool) Whether or not march is a recommended travel time.

april

(bool) Whether or not april is a recommended travel time.

may

(bool) Whether or not may is a recommended travel time.

june

(bool) Whether or not june is a recommended travel time.

july

(bool) Whether or not july is a recommended travel time.

august

(bool) Whether or not august is a recommended travel time.

september

(bool) Whether or not september is a recommended travel time.

october

(bool) Whether or not october is a recommended travel time.

november

(bool) Whether or not november is a recommended travel time.

december

(bool) Whether or not 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.

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.

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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

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) event_host
  • (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 the article is a highlight.

tipIdyllic

(bool) Tip: Idyllisch

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

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 the article is a highlight.

locale

(string) The current language of the category

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 or not 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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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
name

(string) Name of the client.

url

(string) URL of the clients Website.

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.

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.

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.

price
freeEntry

(bool) Whether or not 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.

priceGroups

(array) Array with Price groups and their defined fields

Array Items
comment

(string) String with a user specified Comment to a price group

title

(string) String with a user specified Title to a price group

priceEntries
Array Items
comment

(string) String with a user specified Comment to a price entry

title

(string) String with a user specified Title to a price entry

eur

(float) User specified value for the price in EUR

chf

(float) User specified value for 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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

endPoint

(string) Information about the end point of the tour. May be rich-text.

startPointGettingThere

(string|null) Information about getting to the starting point of the tour.

endPointToStartPoint

(string) Information about getting from the end point back to the start point.

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.

parking

(string) Information about the 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 or not january is a recommended travel time.

february

(bool) Whether or not february is a recommended travel time.

march

(bool) Whether or not march is a recommended travel time.

april

(bool) Whether or not april is a recommended travel time.

may

(bool) Whether or not may is a recommended travel time.

june

(bool) Whether or not june is a recommended travel time.

july

(bool) Whether or not july is a recommended travel time.

august

(bool) Whether or not august is a recommended travel time.

september

(bool) Whether or not september is a recommended travel time.

october

(bool) Whether or not october is a recommended travel time.

november

(bool) Whether or not november is a recommended travel time.

december

(bool) Whether or not 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.

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.

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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

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) event_host
  • (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 the article is a highlight.

tipIdyllic

(bool) Tip: Idyllisch

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

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 the article is a highlight.

locale

(string) The current language of the category

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 or not 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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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) An editor-facing description.

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)

dynamicFieldSets

(array)

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
name

(string) Name of the client.

url

(string) URL of the clients Website.

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.

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.

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.

price
freeEntry

(bool) Whether or not 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.

priceGroups

(array) Array with Price groups and their defined fields

Array Items
comment

(string) String with a user specified Comment to a price group

title

(string) String with a user specified Title to a price group

priceEntries
Array Items
comment

(string) String with a user specified Comment to a price entry

title

(string) String with a user specified Title to a price entry

eur

(float) User specified value for the price in EUR

chf

(float) User specified value for 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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

endPoint

(string) Information about the end point of the tour. May be rich-text.

startPointGettingThere

(string|null) Information about getting to the starting point of the tour.

endPointToStartPoint

(string) Information about getting from the end point back to the start point.

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.

parking

(string) Information about the 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 or not january is a recommended travel time.

february

(bool) Whether or not february is a recommended travel time.

march

(bool) Whether or not march is a recommended travel time.

april

(bool) Whether or not april is a recommended travel time.

may

(bool) Whether or not may is a recommended travel time.

june

(bool) Whether or not june is a recommended travel time.

july

(bool) Whether or not july is a recommended travel time.

august

(bool) Whether or not august is a recommended travel time.

september

(bool) Whether or not september is a recommended travel time.

october

(bool) Whether or not october is a recommended travel time.

november

(bool) Whether or not november is a recommended travel time.

december

(bool) Whether or not 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.

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.

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.

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.

accessRestrictions

(array|null) Access restrictions that might be in place, like proof of health etc.

restrictionDescription

(string|null) Additional access restrictions.

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.

eventRelatedPoints

(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) event_host
  • (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 the article is a highlight.

tipIdyllic

(bool) Tip: Idyllisch

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

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 the article is a highlight.

locale

(string) The current language of the category

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 or not 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 or not 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.

type

(string) Can be either "general" or "specific".

icon

(string)

description

(string) The user facing description.

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