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.

Labels

The system is providing labels in various languages for static model properties (including select options) and dynamic field select values.

These labels can be accessed here for all supported languages:

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

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": {
        "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.28.0

Added

1.27.0

Added

1.26.0

Added

1.25.0

Added

1.24.0

Added

1.23.0

Added

1.22.0

Added

1.21.0

Added

1.19.0

Added

1.18.0

Added

1.17.0

Added

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

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

Fetches the additional address that are associated with an article.

Response

(array) Array of addresses 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.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.
crossiety

(string|null) URL of a crossiety profile.
tiktok

(string|null) URL of a tiktok profile
subject

(HasContactInformationInterface) The item that the contact information are for.
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
vimeoVideo

(string) DEPRECATED, use webMediaLinks
webcam

(string) DEPRECATED, use webMediaLinks
youtubeVideo

(string) DEPRECATED, use webMediaLinks

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'

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

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 email addresses 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'

{
    "_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.eventsAtThisLocation

GET api/v1/article/{article}/eventsAtThisLocation

Fetches the events related to the current event host. This data is only available using include[]=eventsAtThisLocation on the article.show route.

Response

(array) Array of Events containing the following properties

Array Items
name

(string) Name of the event.
eventType

(string) Type of the event.
hasSchedule

(bool) If this event has any dates scheduled.
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: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
type

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

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

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

(bool) Whether the event is canceled.
onDemand

(bool)

boost

(int) Boost value for result ranking.
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.
accessRestrictions
items
ticketRequired

(string) If a ticket is required.
apiVersion

The API version that this event was created by
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-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.
createdAt

The date at which the event was created.
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 1 for monday (7 for sunday).
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.
bookingRequestUrl

(string|null) The link to a booking request.
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
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.
webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

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
trashed

(boolean) Indicates whether the item is deleted.
datesCache

(array) READ ONLY. A list of all event dates with only the relevant data.

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 the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

Examples

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

{
  "_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'

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

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.

Examples

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

{
    "_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.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[]=additionalAddress

Also includes the results of the article.additionalAddress route with the data
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 of type award.
include[]=classifications

Includes the currently valid awards with minimal award blueprint and award set data of type classification.
include[]=memberships

Includes the currently valid awards with minimal award blueprint and award set data of type membership.
include[]=cards

Includes the currently valid awards with minimal award blueprint and award set data of type card.
include[]=prizes

Includes the currently valid awards with minimal award blueprint and award set data of type prize.
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[]=snowReports

Also include snow reports for this item.
include[]=articleTypeAttributes

Also include article-type-specific attributes. E.g. point.
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.
include[]=phoneNumbers

Also include all phone numbers (phone, fax, mobile).
include[]=fieldValues

Also include all dynamic field values. To filter a sub-set of all field values, use includeFieldValues[0]=FIELD_BLUEPRINT_ID.
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.
getSortableProperties
applyChannelToQuery
search
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[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[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[rectangleArea]

Allows filtering for articles by the rectangle.

This property must always be specified as 2 sub-properties and each sub-property is further divided into 2 sub-properties of lat,lng.

  • filter[northeast][lat]
  • filter[northeast][lng]
  • filter[southwest][lat]
  • filter[southwest][lng]

Examples

$ curl http://toubiz.local/api/v1/article
?filter[rectangleArea][0][lat]=33.483224&filter[rectangleArea][0][lng]=73.194616
&filter[rectangleArea][1][lat]=33.483582&filter[rectangleArea][1][lng]=73.202009
filter[type]

Filters articles by their type.

The following types exist:

  • tour
  • point
  • area.

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
  • area
  • city.

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

Examples

$ curl http://toubiz.local/api/v1/article?filter[categoryType]=point
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[currentlyOpen]

Examples

$ curl http://toubiz.local/api/v1/article?filter[currentlyOpen]=1
filter[openAt]

Filter if the point is open at the given datetime. This includes points that are ALWAYS OPEN, or where the regular, seasonal, etc. opening times match.

Examples

$ curl http://toubiz.local/api/v1/article?filter[openAt]=2012-12-31 23:30
$ curl http://toubiz.local/api/v1/article?filter[openAt]=2012-12-31
filter[openToday]

Filter if the point is open at some point between now and midnight.

Examples

$ curl http://toubiz.local/api/v1/article?filter[openToday]=1
filter[recommendedTimeOfTravel]

Filters tours based on recommended time of travel.

Examples

$ curl
    http://toubiz.local/api/v1/article?filter[recommendedTimeOfTravel][from]=1&filter[recommendedTimeOfTravel][to]=4
$ curl
    http://toubiz.local/api/v1/article?filter[recommendedTimeOfTravel][from]=january&filter[recommendedTimeOfTravel][to]=april
$ curl
    http://toubiz.local/api/v1/article?filter[recommendedTimeOfTravel][from]=may&filter[recommendedTimeOfTravel][to]=may
filter[tourDifficulty]

Filters for tour difficulty.

Examples

To filter for all articles with a given difficulty
$ curl http://toubiz.local/api/v1/article?filter[tourDifficulty]=2
filter[tourExperience]

Filters for tour experience with values from 0 to 5.

Examples

To filter for all articles with a given tour experience
$ curl http://toubiz.local/api/v1/article?filter[tourExperience][from]=0&filter[tourExperience][to]=5
filter[tourLandscape]

Filters for tour landscape with values from 0 to 5.

Examples

To filter for all articles with a given tour landscape
$ curl http://toubiz.local/api/v1/article?filter[tourLandscape][from]=0&filter[tourLandscape][to]=5
filter[tourFitness]

Filters for tour fitness with values from 0 to 5.

Examples

To filter for all articles with a given tour fitness value
$ curl http://toubiz.local/api/v1/article?filter[tourFitness][from]=0&filter[tourFitness][to]=5
filter[tourDuration]

Filters for tour duration.

Examples

To filter for all articles with a given duration
$ curl http://toubiz.local/api/v1/article?filter[tourDuration][from]=100&filter[tourDuration][to]=150
filter[tourDistance]

Filters for tour distance in meters.

Examples

To filter for all articles with a given distance
$ curl http://toubiz.local/api/v1/article?filter[tourDistance][from]=2&filter[tourDistance][to]=10
filter[tourElevationUp]

Filters for tour elevation up.

Examples

To filter for all articles with a given elevation (up)
$ curl http://toubiz.local/api/v1/article?filter[tourElevationUp][from]=2&filter[tourElevationUp][to]=10
filter[tourTechnique]

Filters for tour technique.

Examples

To filter for all articles with a given tour technique
$ curl http://toubiz.local/api/v1/article?filter[tourTechnique][from]=0&filter[tourTechnique][to]=5
filter[tourType]

Filters for tour type.

Examples

To filter for all articles with a given tour type
$ curl http://toubiz.local/api/v1/article?filter[tourType]=loop_tour
filter[tourHighlight]

Filters for tour highlight.

Examples

To filter for all articles with a given tour highlight
$ curl http://toubiz.local/api/v1/article?filter[tourHighlight][0]=culture
filter[eventLocationCapacity]

Filter for articles based on service event location aspect capacity.

Event location aspects are defined as numberBanquet, numberBlock, numberTheater, numberHorseShoe, numberSeminar and numberStanding.

Examples

To filter for articles with all event location aspects between 20 and 50.
$ curl
    http://toubiz.local/api/v1/article?filter[eventLocationCapacity][from]=20&filter[eventLocationCapacity][to]=50
To filter for articles with minimum numberStanding of 20.
$ curl
    http://toubiz.local/api/v1/article?filter[eventLocationCapacity][from]=200&filter[eventLocationCapacity][types][0]=numberStanding
To filter for articles with maximum numberStanding of 200.
$ curl
    http://toubiz.local/api/v1/article?filter[eventLocationCapacity][from]=200&filter[eventLocationCapacity][types][0]=numberStanding
To filter for articles with both numberBanquet and numberStanding between 20 and 200.
$ curl
    http://toubiz.local/api/v1/article?filter[eventLocationCapacity][from]=20&filter[eventLocationCapacity][to]=200&filter[eventLocationCapacity][types][0]=numberBanquet&filter[eventLocationCapacity][types][1]=numberStanding
filter[eventLocationSize]

Filter for articles based on service event location size in square meters.

Examples

To filter for articles event location size between 20 and 200 square meter.
$ curl http://toubiz.local/api/v1/article?filter[eventLocationSize][from]=20&filter[eventLocationSize][to]=200
To filter for articles with minimum event location size of 50 square meter.
$ curl http://toubiz.local/api/v1/article?filter[eventLocationSize][from]=50
To filter for articles with maximum event location size of 100 square meter.
$ curl http://toubiz.local/api/v1/article?filter[eventLocationSize][to]=100
filter[prepared]

Filter for articles based on snow report prepared aspect.

Examples

To filter for articles with snow report preparation aspect set to yes.
$ curl http://toubiz.local/api/v1/article?filter[prepared]=yes
To filter for articles with snow report preparation aspect set to no.
$ curl http://toubiz.local/api/v1/article?filter[prepared]=no
To filter for articles with undefined snow report preparation aspect.
$ curl http://toubiz.local/api/v1/article?filter[prepared]=undefined
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[awards]

Filter for items that have one or more of the requested awards.

The filter value must be an array of either award blueprints or the ids of the award blueprints.
filter[classifications]

Filter for items that have one or more of the requested classifications.

The filter value must be an array of either classification blueprints or the ids of the classification blueprints.
filter[awardTypes]

Filters for award types.

Examples

To filter for all articles with card award types
$ curl http://toubiz.local/api/v1/article?filter[awardTypes][0]=classification
To filter for all articles with card and prize award types
$ curl http://toubiz.local/api/v1/article?filter[awardTypes][0]=classification&filter[awardTypes][1]=award
filter[awardDomains]

Filters for award domains.

Examples

To filter for all articles with card award domains
$ curl http://toubiz.local/api/v1/article?filter[awardDomains][0]=card
To filter for all articles with card and prize award domains
$ curl http://toubiz.local/api/v1/article?filter[awardDomains][0]=card&filter[awardDomains][1]=prize
filter[accommodation]

Filter for articles based on service accommodationAspect.

Possible accommodation aspects are

  • bathrooms
  • beds
  • entrance
  • exterior
  • facilities
  • kitchen
  • laundry
  • view

Examples

$ curl
http://toubiz.local/api/v1/article?filter[accommodation][bathrooms][0]=shower&filter[accommodation][bathrooms][1]=shampoo
$ curl
    http://toubiz.local/api/v1/article?filter[accommodation][beds]=double&filter[accommodation][kitchen]=couch,fridge
$ curl
    http://toubiz.local/api/v1/article?filter[accommodation][view]=lake&filter[accommodation][kitchen]=couch,fridge&filter[accommodation][beds]=double
filter[excludeCategory]

Excludes articles/events 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[category]

Filters articles/events 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/event?filter[category][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/article?filter[category]=12,14
$ curl http://toubiz.local/api/v1/event?filter[category]=12,14
filter[categoryWithSecondary]

Filters articles/events 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/event?filter[categoryWithSecondary][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/article?filter[categoryWithSecondary]=12,14
$ curl http://toubiz.local/api/v1/event?filter[categoryWithSecondary]=12,14
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[createdBy]

Allows filtering for the creator of an item.

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

  • Array of ids
  • Comma separated string.
filterDeleted
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
filter[lastEditedBy]

Allows filtering for the last editing user of an item.

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

  • Array of ids
  • Comma separated string.
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[withManualPermission]

Filters items by manual permissions.

Examples

$ curl http://toubiz.local/api/v1/article?filter[withManualPermission]=1
filter[pitchMaxLength]

Filter for articles based on service pitch aspect maxLength in meter.

Examples

To filter for articles service pitch aspect maxLength between 20 and 200 meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchMaxLength][from]=20&filter[pitchMaxLength][to]=200
To filter for articles with minimum service pitch aspect maxlength of 50 meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchMaxLength][from]=50
To filter for articles with maximum service pitch aspect maxLength of 100 meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchMaxLength][to]=100
filter[pitchSize]

Filter for articles based on service pitch aspect size in square meters.

Examples

To filter for articles service pitch aspect size between 20 and 200 square meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchSize][from]=20&filter[pitchSize][to]=200
To filter for articles with minimum service pitch aspect size of 50 square meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchSize][from]=50
To filter for articles with maximum service pitch aspect size of 100 square meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchSize][to]=100
filter[vehicleType]

Filter for articles based on service pitch aspect vehicleType.

Examples

$ curl http://toubiz.local/api/v1/article?filter[vehicleType]=camper,panel_van
$ curl http://toubiz.local/api/v1/article?filter[vehicleType][0]=camper&filter[vehicleType][1]=panel_van
filter[services]

Filters articles by attached services.

This property can either be an array of service types or an array of arrays, where the key is the service type and the nested array is a list of sub-types.

Valid types with sub-types are:

  • accommodation [room, apartment, special]
  • event_location [banquet_hall, conference_room, meeting_room, exhibition_space, auditorium]
  • various [flat_rate, ticket, rental, wellness]

Examples

Return all articles with services:
$ curl http://toubiz.local/api/v1/article?filter[services][]=
Return all articles with accommodation services:
$ curl http://toubiz.local/api/v1/article?filter[services][]=accommodation
Return all articles with accommodation services that are rooms:
$ curl http://toubiz.local/api/v1/article?filter[services][accommodation][]=room
filterSourceSystemInformation
filterSourceSystem
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[excludeTag]

Only fetches entities not with the given tags.

Examples

# Multiple tags
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag][]=foo&filter[excludeTag][]=bar
# Multiple tags comma-separated
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag]=foo,bar
# Single tag
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag]=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
filter[deletedAfter]

Retrieves only trashed data from the parent table at a specified date.
filter[updatedAfter]

Only returns items that have been updated after the given date & time.

This property can be used together with filter[updatedBefore] in order to only select items that have been edited in a given timespan.

Examples

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

Only returns items that have been updated before the given date & time.

This property can be used together with filter[updatedAfter] in order to only select items that have been edited in a given timespan.

Examples

curl http://toubiz.local/api/v1/[article|event]?filter[updatedBefore]=2018-08-01
curl http://toubiz.local/api/v1/[article|event]?filter[updatedBefore]=2018-08-01T00:12:00
filter[createdAt]

Filter article or events based on created at.

Examples

curl http://toubiz.local/api/v1/article?filter[createdAt][after]=2018-08-01
curl http://toubiz.local/api/v1/article?filter[createdAt][before]=2018-08-01
curl http://toubiz.local/api/v1/event?filter[createdAt][after]=2018-08-01&filter[createdAt][before]=2018-09-01
orderByIdFilter
filter[auditor]

Allows filtering for the auditor of an item.

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

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.

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": {
        "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.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
agreedUsageRightsAt

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

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

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

(string) The checksum of the underlying file.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
tags

(array<MediaTag>) Tags can be added to media for special treatment. This can be a a different displaying, no displaying, etc.
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-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

{
    "_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.nearbyArticles

GET api/v1/article/{article}/nearbyArticles

Response

areas

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
areaAccommodations

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
areaHighlights

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
areaParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
areaPublicTransport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
discoveries

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
gastronomy

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
generic

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
iceSkating

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
connectedPoints

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
pointGettingThereParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
relatedContacts

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
sights

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
snowGear

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
snowSlopes

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
snowToboggan

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
snowTrails

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
snowTransportation

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tours

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourAccommodations

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourContact

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourEndParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourEndPoint

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourEndPublicTransport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourInfrastructure

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourRefreshmentPoints

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourRelatedTours

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourSights

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourStages

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourStagesVariants

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourStartParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourStartPoint

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourStartPublicTransport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
tourSupport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.

article.nearbyEvents

GET api/v1/article/{article}/nearbyEvents

Response

(array) Array of events containing the following properties

Array Items
name

(string) Name of the event.
eventType

(string) Type of the event.
hasSchedule

(bool) If this event has any dates scheduled.
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: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
type

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

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

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

(bool) Whether the event is canceled.
onDemand

(bool)

boost

(int) Boost value for result ranking.
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.
accessRestrictions
items
ticketRequired

(string) If a ticket is required.
apiVersion

The API version that this event was created by
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-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.
createdAt

The date at which the event was created.
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 1 for monday (7 for sunday).
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.
bookingRequestUrl

(string|null) The link to a booking request.
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
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.
webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

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
trashed

(boolean) Indicates whether the item is deleted.
datesCache

(array) READ ONLY. A list of all event dates with only the relevant data.

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|null) 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.
  • null: No information available.
description

(string) A prosaic description of the opening times as an alternative to structured data.
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|null) 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 the opening times apply on mondays. Only relevant for regular opening times.
tuesday

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

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

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

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

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

(bool) Whether 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'

  {
      "_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, mobile.
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'

{
    "_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.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

areas

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

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

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

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

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

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

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

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

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

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

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

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

(boolean) Indicates whether the item is deleted.
areaAccommodations

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

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

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

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

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

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

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

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

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

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

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

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
areaHighlights

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
areaParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
areaPublicTransport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
discoveries

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
gastronomy

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
generic

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
iceSkating

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
connectedPoints

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
pointGettingThereParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
relatedContacts

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
sights

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
snowGear

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
snowSlopes

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
snowToboggan

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
snowTrails

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
snowTransportation

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tours

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourAccommodations

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourContact

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourEndParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourEndPoint

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourEndPublicTransport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourInfrastructure

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourRefreshmentPoints

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourRelatedTours

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourSights

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourStages

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourStagesVariants

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourStartParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourStartPoint

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourStartPublicTransport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
tourSupport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.

Examples

$ curl http://toubiz.ddev.site/api/v1/article/3eb7a16b-cde7-3cea-bd24-2ad0bd39de4a/relatedArticles?api_token=TOKEN

{
    "_warning": [],
    "_attributes": { ... },
    "_errors": [],
    "payload": {
        "generic": [
            {
                "id": "00112314-91c2-3b0b-86f5-d1e2aa697c1d",
                "name": "Amphith\u00e9atre",
                "abstract": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque eu blandit orci. Proin efficitur diam a lorem egestas, vel suscipit leo condimentum. Curabitur a purus euismod, ullamcorper metus quis, pretium turpis.",
                "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque eu blandit orci. Proin efficitur diam a lorem egestas, vel suscipit leo condimentum. Curabitur a purus euismod, ullamcorper metus quis, pretium turpis. Pellentesque dictum, eros ac tristique scelerisque, nunc lectus neque, at pellentesque libero diam nec orci. Nunc feugiat imperdiet egestas. Morbi ut elementum ipsum, sit amet tempus sem. Donec vitae pellentesque ex. Etiam egestas malesuada erat, et vulputate urna molestie eu. Proin vitae placerat quam, vel finibus augue. Nam lobortis ipsum nisl, aliquet congue sem euismod quis.\n\nDonec sed nulla purus. Morbi elementum lacus tellus, quis faucibus arcu luctus nec. Quisque congue ipsum dolor, non gravida nisl semper et. Sed viverra varius tellus, non feugiat eros cursus rhoncus. Duis a sagittis massa. Nam id velit diam. Donec quis iaculis purus.\n\nMaecenas non eros quis metus tincidunt commodo. Cras euismod posuere dictum. Nullam iaculis sit amet massa in eleifend. Cras pulvinar elit mi, ac rhoncus nunc luctus vitae. Quisque vitae nulla ultrices, aliquam metus non, porta metus. Aenean quis auctor lorem. Curabitur eros ante, efficitur quis fermentum eget, sollicitudin a tortor. Ut volutpat vel erat eget volutpat. Curabitur faucibus dolor non sollicitudin efficitur. Integer condimentum dignissim purus, in placerat lacus ultricies vel. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae;",
                "generalInformation": "",
                "type": "point",
                "primaryCategory": {
                    "id": "c41cbedd-3692-3ca2-b313-c8be50847bf2",
                    "name": "Historisches Geb\u00e4ude",
                    "nameWithParents": "POI und Infrastruktur \u00bb Bauwerk \u00bb Historisches Geb\u00e4ude",
                    "type": "point",
                    "invisible": false
                },
                "private": false,
                "invisible": false,
                "updatedAt": "2018-06-27T06:16:55",
                "tipHighlight": false
            }
        ],
        "tourStartPublicTransport": [],
        "tourStartParking": [],
        "tourEndPublicTransport": [],
        "tourEndParking": [],
        "tourContact": []
    }
}

article.relatedEvents

GET api/v1/article/{article}/relatedEvents

Response

nearbyEvents

(array) Array of events containing the following properties

Array Items
name

(string) Name of the event.
eventType

(string) Type of the event.
hasSchedule

(bool) If this event has any dates scheduled.
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: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
type

(string) Type of the event. Must be one of local, regional, multiregional.
intro

(string|null) Short intro text about the event. May contain rich-text.
mergeDates

(bool) Whether to merge dates of intervals in the frontend.
canceled

(bool) Whether the event is canceled.
onDemand

(bool)

boost

(int) Boost value for result ranking.
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.
accessRestrictions
items
ticketRequired

(string) If a ticket is required.
apiVersion

The API version that this event was created by
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-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.
createdAt

The date at which the event was created.
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 1 for monday (7 for sunday).
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.
bookingRequestUrl

(string|null) The link to a booking request.
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
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.
webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

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
trashed

(boolean) Indicates whether the item is deleted.
datesCache

(array) READ ONLY. A list of all event dates with only the relevant data.

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 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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/seo?api_token=admin_token'

  {
      "_warning": [],
      "_attributes": [],
      "_errors": [],
      "payload": {
          "id": "fff2a63a-b323-4828-9b61-f9fcb426d565",
          "metaDescription": "",
          "noIndex": false,
          "openGraphDescription": "",
          "openGraphImage": null,
          "openGraphTitle": ""
      }
  }⏎

article.services

GET api/v1/article/{article}/services

Response

(array) Array of Services containing the following properties

Array Items
name

(string)

description

(string)

type

The type of service.

Enum:
  • (string) accommodation
  • (string) various
  • (string) event_location
  • (string) pitch
invisible

(bool)

accommodationAspect
documentation

Accommodation specific properties.
item
approvalNumber

(string|null)

minNights

(int|null)

number

(int|null) The number of rooms, apartments, etc.
numberBathrooms

(int|null) The number of bathrooms.
numberBedrooms

(int|null) The number of bedrooms.
numberBeds

(int|null) The number of beds.
occupancyMax

(int|null)

occupancyMin

(int|null)

sizeFrom

(int|null) The smallest accommodation.
sizeTo

(int|null) The biggest accommodation.
type

The type of accommodation.

Enum:
  • (string) room
  • (string) apartment
  • (string) special
selectedValues
documentation

The selected options.
options

Possible options are: {"beds":["oversized","queen_size","french","extra","sofa_bed","single","double","bunk","sofa_bed_double","other"],"bathrooms":["bathroom","shower","bathtub","shared_bathroom","shared_shower","shared_toilet","toilet","separate_toilet","hair_dryer","shower_gel","shampoo","no_running_water","no_hot_water"],"entrance":["ground_floor","separate"],"facilities":["minibar","safe","cd_player","radio","stereo","tv","wifi","phone","air_conditioning","heat"],"laundry":["washing_machine","dryer","flat_iron","laundry_service","sheets","towels","basic_equipment"],"kitchen":["basic_equipment","basic_equipment_cook","basic_equipment_washup","seating_area","eating_area","couch","fireplace","tiled_fireplace","stove","oven","dish_washer","microwave","fridge","freezer","coffee_machine","water_boiler","dishes_cutlery"],"exterior":["patio","balcony","garden_furniture","eating_area"],"view":["lake","mountains","valley","skyline","sea"]}
eventLocationAspect
documentation

Event location specific properties.
item
ceilingHeight

(float|null) The ceiling height in meters.
numberBanquet

(int|null) The number of seats in banquet layout.
numberBlock

(int|null) The number of seats in block layout.
numberHorseShoe

(int|null) The number of seats in horse shoe layout.
numberSeminar

(int|null) The number of seats in seminar layout.
numberStanding

(int|null) The number of places at bar tables.
numberTheater

(int|null) The number of seats in theater layout.
size

(int|null) The room site in square meters.
type

The type of event location.

Enum:
  • (string) auditorium
  • (string) banquet_hall
  • (string) conference_room
  • (string) event_room
  • (string) exhibition_space
  • (string) meeting_room
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>)

selectedValues
documentation

The selected options.
options

Possible options are: {"beds":["oversized","queen_size","french","extra","sofa_bed","single","double","bunk","sofa_bed_double","other"],"bathrooms":["bathroom","shower","bathtub","shared_bathroom","shared_shower","shared_toilet","toilet","separate_toilet","hair_dryer","shower_gel","shampoo","no_running_water","no_hot_water"],"entrance":["ground_floor","separate"],"facilities":["minibar","safe","cd_player","radio","stereo","tv","wifi","phone","air_conditioning","heat"],"laundry":["washing_machine","dryer","flat_iron","laundry_service","sheets","towels","basic_equipment"],"kitchen":["basic_equipment","basic_equipment_cook","basic_equipment_washup","seating_area","eating_area","couch","fireplace","tiled_fireplace","stove","oven","dish_washer","microwave","fridge","freezer","coffee_machine","water_boiler","dishes_cutlery"],"exterior":["patio","balcony","garden_furniture","eating_area"],"view":["lake","mountains","valley","skyline","sea"]}
pitchAspect
documentation

Pitch specific properties.
item
typeOfPlace

(string|null) Type of place.
maxLength

(float|null) The maximum length a vehicle can have.
number

(int|null) The number of places.
size

(int|null) The size from the place.
undergroundOption

(string|null) The texture of the underground.
type

The type of pitch aspect.

Enum:
  • (string) camper_place
  • (string) campsite
selectedValues
documentation

The selected options.
options

Possible options are: {"vehicleType":["caravan","panel_van","vehicle_with_roof_tent","camper","campervan","thick_ships"],"view":["lake","mountains","valley","skyline","sea"]}

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'

{
  "_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.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[]=additionalAddress

Also includes the results of the article.additionalAddress route with the data
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[]=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[]=memberships

Include the awards of type membership given to this articles
include[]=cards

Include the awards of type card given to this articles
include[]=prizes

Include the awards of type prize given to this articles
include[]=locationIdentifiers

Include the location identifier for this area
include[]=floodlights

Include the active times of the floodlights at a slope.
include[]=services

Include any services that are offered, like accommodation, rentals, etc.
include[]=itemPermissions

Also include the manual permissions for all users.
include[]=snowReports

Also include snow reports for this item.
include[]=snowReportsInherited

Also include the inherited snow reports for this item.
include[]=openingTimes

Also includes the opening times definition. Only for points.

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) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current entities language identifier.
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
defaultMapCenterLatitude

(float) Latitude of default map center.
defaultMapCenterLongitude

(float) Longitude of default map center.
owner

(string) Owner of the client.
legalClient

(object) The client handling legal matters (Terms of service, etc.)

Properties
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
integrations
documentation

(object) Data for integration with external services.
defaultLicense
Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (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.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
auditor

(string) The display name of the person who last changed this item.
boost

(int) Boost value for result ranking.
what3wordsAddress

(string|null) What3Words address against latitude and longitude of the article.
createdBy

(User|null)

secondaryCategories

(array) Information about the secondary categories of the article.

Array Items
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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.
hasSchedule

(bool) If this event has any dates scheduled.
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: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
type

(string) Type of the event. Must be one of local, regional, multiregional.
intro

(string|null) Short intro text about the event. May contain rich-text.
mergeDates

(bool) Whether to merge dates of intervals in the frontend.
canceled

(bool) Whether the event is canceled.
onDemand

(bool)

boost

(int) Boost value for result ranking.
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.
accessRestrictions
items
ticketRequired

(string) If a ticket is required.
apiVersion

The API version that this event was created by
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-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.
createdAt

The date at which the event was created.
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 1 for monday (7 for sunday).
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.
bookingRequestUrl

(string|null) The link to a booking request.
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
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.
webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

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
trashed

(boolean) Indicates whether the item is deleted.
datesCache

(array) READ ONLY. A list of all event dates with only the relevant data.
snowReportsInherited

(array) The snow reports that are attached to the ski area that this item might be attached to.
snowReportsHidden

(array) A list of IDs of those inherited snow reports that should not be displayed.
services

(array) Services that are port of this article.

Array Items
name

(string)

description

(string)

type

The type of service.

Enum:
  • (string) accommodation
  • (string) various
  • (string) event_location
  • (string) pitch
invisible

(bool)

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31?api_token=admin_token'

{
    "_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.tags

GET api/v1/article/{article}/tags

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 this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
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.
apiVersion

(int)

boost

(int) Boost value for result ranking.
what3wordsAddress

(string|null) What3Words address against latitude and longitude of the 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.
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 ] } ]
     }
}
client

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
syncFiles

Associate files with an item.

  • If a new file should be associated, then the key file must contain the multipart/form-data file upload, or url must reference a URL from which the file can be downloaded.
  • If an existing file is referenced, then the key id must be set.

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": "e37a6365-9e9f-4f1a-858a-c8f94b5a1580",
         "name": "Updated name",
         "description": "Updated description"
     }, {
         "file": "https://placehold.it/500x500"
     }]
}
fillRelatedArticles

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" ]
     }
}
relatedEvents

Updates the related events 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. Events can either be passed as simple ids or objects containing ids.

Examples

{
     "relatedEvents": {
         "relatedEvents": [
             { "id": "6ecfc88a-8684-47d9-9464-881a94fc63f6" }
         ]
     }
}
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.
tags

Updates the list of tags that are associated with the item. Tags are passed using an array of strings.

Examples

{
     "tags": [ "foo", "bar", "baz" ],
}
point

Saves point specific attributes for the article. If the value null is passed then all point specific attributes are deleted.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
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,
         "marketingPriceComment": "Lorem ipsum",
         "marketingPrices": [
             [
                 "id": "123-456-789"
                 "currency": "eur"
                 "price": 2.4
             ],
             [
                 "id": "987-654-321"
                 "currency": "chf"
                 "price": 2.5
             ]
         ],
         "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 entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

priceGroups
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.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
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.
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.
zipCodes
seo

Update the seo information of the item.

Examples

{
     "seo": {
         "metaDescription": "A super cool hotel",
         "openGraphDescription": "The best hotel in the world",
         "openGraphTitle": "Hotel Mama",
         "noIndex": false,
         "openGraphImage": { "id": "bd15eaf8-dcd2-4cc3-b528-c83028cefa1a" }
     }
}
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 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 item. 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": "ddb6a32e-0a56-4c88-b108-35214b3a9532",
         "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
agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
author

(string) Display name of author for this item.
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" } } } }
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
main

(bool) Set to true if this media is the primary element for the given article/event.
files
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.
crossiety

(string|null) URL of a crossiety profile.
tiktok

(string|null) URL of a tiktok profile
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",
         "description": "closes at 09:00 PM",
         "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",
             "openState": "times",
             "comment": "Zwischen den Jahren nur Sonntags abends geöffnet",
             "startOn": "2018-12-25",
             "endOn": "2019-01-01",
             "seasonalChildren": [{
                 "type": "seasonal_child",
                 "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, null
description

(string) A prosaic description of the opening times as an alternative to structured data.
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|null) 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 the opening times apply on mondays. Only relevant for regular opening times.
tuesday

(bool) Whether the opening times apply on $tuesdays. Only relevant for regular opening times.
wednesday

(bool) Whether the opening times apply on $wednesdays. Only relevant for regular opening times.
thursday

(bool) Whether the opening times apply on $thursdays. Only relevant for regular opening times.
friday

(bool) Whether the opening times apply on $fridays. Only relevant for regular opening times.
saturday

(bool) Whether the opening times apply on $saturdays. Only relevant for regular opening times.
sunday

(bool) Whether 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, mobile.
iso5008

Originally phone numbers where stored with semantic grouping. We will transition to a single, complete string.
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
Enum:
  • (string) areas
  • (string) areaAccommodations
  • (string) areaHighlights
  • (string) areaParking
  • (string) areaPublicTransport
  • (string) discoveries
  • (string) gastronomy
  • (string) generic
  • (string) iceSkating
  • (string) connectedPoints
  • (string) pointGettingThereParking
  • (string) relatedContacts
  • (string) sights
  • (string) snowGear
  • (string) snowSlopes
  • (string) snowToboggan
  • (string) snowTrails
  • (string) snowTransportation
  • (string) tours
  • (string) tourAccommodations
  • (string) tourContact
  • (string) tourEndParking
  • (string) tourEndPoint
  • (string) tourEndPublicTransport
  • (string) tourInfrastructure
  • (string) tourRefreshmentPoints
  • (string) tourRelatedTours
  • (string) tourSights
  • (string) tourStages
  • (string) tourStagesVariants
  • (string) tourStartParking
  • (string) tourStartPoint
  • (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)
fillImage

Sets the 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.
type

(string) The type of the web link

Enum:
  • (string) aerial3d
  • (string) camera360
  • (string) trailPlan
  • (string) vimeoVideo
  • (string) webcam
  • (string) youtubeVideo
services
Array Items
name

(string)

description

(string)

type

(string)

invisible

(bool)

files
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
syncFiles

Associate files with an item.

  • If a new file should be associated, then the key file must contain the multipart/form-data file upload, or url must reference a URL from which the file can be downloaded.
  • If an existing file is referenced, then the key id must be set.

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": "e37a6365-9e9f-4f1a-858a-c8f94b5a1580",
         "name": "Updated name",
         "description": "Updated description"
     }, {
         "file": "https://placehold.it/500x500"
     }]
}
media

Modifies the media elements associated with the item. 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": "ddb6a32e-0a56-4c88-b108-35214b3a9532",
         "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"
     }]
}
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,
         "marketingPriceComment": "Lorem ipsum",
         "marketingPrices": [
             [
                 "id": "123-456-789"
                 "currency": "eur"
                 "price": 2.4
             ],
             [
                 "id": "987-654-321"
                 "currency": "chf"
                 "price": 2.5
             ]
         ],
         "priceTable": [
             [ "Personengruppe",                 "Preis"     ],
             [ "Kinder bis 6 Jahre",             "kostenlos" ],
             [ "Kinder bis 14 Jahre",            "7 Euro"    ],
             [ "Erwachsene",                     "15 Euro"   ],
             [ "Schüler, Studenten und Rentner", "12 Euro"   ],
         ]
     }
}

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'

{
  "_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'

{
    "_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"
            }
        ],
    }
}

event.index

GET api/v1/event

Lists all events that are visible to the user. By default invisible & private events are hidden and can be enabled using the &invisible=1 and &private=1 request parameters.

Attributes

include[]=languages

Include languages in the response
include[]=externalIds

Also includes the ids from other services for this event
include[]=mainImage

Includes the main image of the area if supplied
include[]=permissions

Include permissions in the response
include[]=images

Include preview images in the response
include[]=seo

Include SEO Information in the response
include[]=distance

Includes the distance to the requested coordinates. Requires the distanceFrom filter.
include[]=awards

Includes the currently valid awards with minimal award blueprint and award set data.
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.
applyChannelToQuery
filter[rectangleArea]

Allows filtering for events by the rectangle.

This property must always be specified as 2 sub-properties and each sub-property is further divided into 2 sub-properties of lat,lng.

  • filter[northeast][lat]
  • filter[northeast][lng]
  • filter[southwest][lat]
  • filter[southwest][lng]

Examples

$ curl http://toubiz.local/api/v1/event
?filter[rectangleArea][0][lat]=33.483224&filter[rectangleArea][0][lng]=73.194616
&filter[rectangleArea][1][lat]=33.483582&filter[rectangleArea][1][lng]=73.202009
client

Only returns the events that belong to the client with the given id.

The string current can be supplied to reference the client of the current user.

If this property is not set then all events visible to the current user will be returned (including public events of foreign clients).
search

Searches the events for the given search query.

This will search the following fields of an event:

  • name
  • description
  • intro.
sorting

Allows to sort the event 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
filter[externalId]

Filters events 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/event?filter[externalId]=sourceName:sourceId
$ curl
http://toubiz.local/api/v1/event?filter[externalId][]=sourceName:sourceId_1&filter[externalId][]=sourceName:sourceId_2
$ curl http://toubiz.local/api/v1/event?filter[externalId]=sourceName:sourceId_1,sourceName:sourceId_2
filter[host]

Filters for events that belong to the given host.

If multiple hosts are passed then the following formats may be used:

  • Array of ids
  • Comma separated ids.
filter[location]

Filters for events that are happening at the given location.

If multiple locations are passed then the following formats may be used:

  • Array of ids
  • Comma separated ids.
filter[locationArea]

Filters for events that are happening at any location that is associated with a given area.

Warning: The actual address might not reflect that.

If multiple areas are passed then the following formats may be used:

  • Array of ids
  • Comma separated ids
filter[area]

See filter[locationArea].
filter[city]

See filter[locationArea].
filter[type]

Allows filtering for the event type.

Valid types are: regional, multiregional, local.

Examples

$ curl http://toubiz.local/api/v1/event?filter[type]=regional,local
$ curl http://toubiz.local/api/v1/event?filter[type][]=regional&filter[type][]=multiregional
{ "filter": { "type": [ "multiregional", "regional" ] } }
$ curl http://toubiz.local/api/v1/event?filter[type]=regional
filter[eventType]

Allows filtering for the eventType.

Valid types are: event, experience.
filter[itemType]
filter[date]

Filters events by their date.

This property must be supplied as an array containing at least one of the following attributes:

  • filter[date][before]
  • filter[date][after].

If both are supplied, then the events are filtered for dates between after - before. All filtering is done inclusively, meaning that filtering for

  • filter[date][after]=2020-12-23&filter[date][before]=2020-12-25 will include events on the 23rd, 24th and 25th
  • filter[date][after]=2020-12-24&filter[date][before]=2020-12-24 will include events on the 24th only

All dates must be passed as YYYY-MM-DD.
filterDateRange
filter[inCollection]

Filter for events that are in the given collection with the given id.

Examples

{ "filter": { "inCollection": 2 } }
filter[notInCollection]

Filter for events that are not in the given collection with the given id.

This is the opposite of filter[inCollection].

Examples

{ "filter": { "inCollection": 2 } }
filter[element]

Filters the events to only include those matching the given element.
filter[distanceFrom]

Allows filtering for events by their location coordinates.

This property must always be specified as 3 sub-properties:

  • filter[distanceFrom][latitude]
  • filter[distanceFrom][longitude]
  • filter[distanceFrom][radiusMeters].
filter[withUpcomingEventDates]

Filter events that have relevant event dates coming up.

"daysInPast" can be used to shift the cut-off point into the past. With a "daysInPast" of 1, this will also return events that were still relevant yesterday. This way, events that just happened are not immediately "lost" to the consuming call.
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[awards]

Filter for items that have one or more of the requested awards.

The filter value must be an array of either award blueprints or the ids of the award blueprints.
filter[classifications]

Filter for items that have one or more of the requested classifications.

The filter value must be an array of either classification blueprints or the ids of the classification blueprints.
filter[awardTypes]

Filters for award types.

Examples

To filter for all articles with card award types
$ curl http://toubiz.local/api/v1/article?filter[awardTypes][0]=classification
To filter for all articles with card and prize award types
$ curl http://toubiz.local/api/v1/article?filter[awardTypes][0]=classification&filter[awardTypes][1]=award
filter[awardDomains]

Filters for award domains.

Examples

To filter for all articles with card award domains
$ curl http://toubiz.local/api/v1/article?filter[awardDomains][0]=card
To filter for all articles with card and prize award domains
$ curl http://toubiz.local/api/v1/article?filter[awardDomains][0]=card&filter[awardDomains][1]=prize
filter[excludeCategory]

Excludes articles/events 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[category]

Filters articles/events 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/event?filter[category][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/article?filter[category]=12,14
$ curl http://toubiz.local/api/v1/event?filter[category]=12,14
filter[categoryWithSecondary]

Filters articles/events 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/event?filter[categoryWithSecondary][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/article?filter[categoryWithSecondary]=12,14
$ curl http://toubiz.local/api/v1/event?filter[categoryWithSecondary]=12,14
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[createdBy]

Allows filtering for the creator of an item.

This filter can be specified in one of the following formats if multiple users are filtered for:

  • Array of ids
  • Comma separated string.
filterDeleted
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
filter[lastEditedBy]

Allows filtering for the last editing user of an item.

This filter can be specified in one of the following formats if multiple users are filtered for:

  • Array of ids
  • Comma separated string.
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[withManualPermission]

Filters items by manual permissions.

Examples

$ curl http://toubiz.local/api/v1/article?filter[withManualPermission]=1
filterSourceSystemInformation
filterSourceSystem
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[excludeTag]

Only fetches entities not with the given tags.

Examples

# Multiple tags
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag][]=foo&filter[excludeTag][]=bar
# Multiple tags comma-separated
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag]=foo,bar
# Single tag
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag]=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
filter[deletedAfter]

Retrieves only trashed data from the parent table at a specified date.
filter[updatedAfter]

Only returns items that have been updated after the given date & time.

This property can be used together with filter[updatedBefore] in order to only select items that have been edited in a given timespan.

Examples

curl http://toubiz.local/api/v1/event?filter[updatedAfter]=2018-08-01
curl http://toubiz.local/api/v1/event?filter[updatedAfter]=2018-08-01T00:12:00
filter[updatedBefore]

Only returns items that have been updated before the given date & time.

This property can be used together with filter[updatedAfter] in order to only select items that have been edited in a given timespan.

Examples

curl http://toubiz.local/api/v1/[article|event]?filter[updatedBefore]=2018-08-01
curl http://toubiz.local/api/v1/[article|event]?filter[updatedBefore]=2018-08-01T00:12:00
filter[createdAt]

Filter article or events based on created at.

Examples

curl http://toubiz.local/api/v1/article?filter[createdAt][after]=2018-08-01
curl http://toubiz.local/api/v1/article?filter[createdAt][before]=2018-08-01
curl http://toubiz.local/api/v1/event?filter[createdAt][after]=2018-08-01&filter[createdAt][before]=2018-09-01
filter[auditor]

Allows filtering for the auditor of an item.
orderByIdFilter

Response

(array) Array of events containing the following properties

Array Items
name

(string) Name of the event.
eventType

(string) Type of the event.
hasSchedule

(bool) If this event has any dates scheduled.
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: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
type

(string) Type of the event. Must be one of local, regional, multiregional.
intro

(string|null) Short intro text about the event. May contain rich-text.
mergeDates

(bool) Whether to merge dates of intervals in the frontend.
canceled

(bool) Whether the event is canceled.
onDemand

(bool)

boost

(int) Boost value for result ranking.
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.
accessRestrictions
items
ticketRequired

(string) If a ticket is required.
apiVersion

The API version that this event was created by
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-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.
createdAt

The date at which the event was created.
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 1 for monday (7 for sunday).
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.
bookingRequestUrl

(string|null) The link to a booking request.
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
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.
webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

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
trashed

(boolean) Indicates whether the item is deleted.
datesCache

(array) READ ONLY. A list of all event dates with only the relevant data.

Examples

$ curl -g -X GET \
    'http://toubiz.local/api/v1/event?api_token=admin_token&pagination[pageSize]=5&filter[date][after]=2018-01-01'

{
    "_links": {
        "previousPage": null,
        "nextPage": "http://toubiz.local/api/v1/event?api_token=admin_token&pagination[pageSize]=5&filter[date][after]=2018-01-01&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."
    ],
    "_attributes": {
        "pagination": {
            "pageSize": 5,
            "page": 1,
            "total": 377,
            "lastPage": 76
        },
        "filter": {
            "date": {
                "after": "2018-01-01"
            }
        }
    },
    "_errors": [],
    "payload": [
        {
            "id": "b1e1e5ad-560b-4fdd-ab96-2b4979332adc",
            "name": "Gigantic growler",
            "intro": "<p>Hier steht die deutsche Kurzbeschreibung</p>",
            "type": "regional",
            "bookingUrl": "https://www.super-deutsches-buchungssystem.com",
            "bookingHotline": "test",
            "location": null,
            "host": 120,
            "invisible": false,
            "private": false,
            "category": {
                "id": "660a10b6-7d48-444e-8421-31afcb2ed8fc",
                "name": "Kinder &amp; Familien",
                "nameWithParents": "Event \u00bb Kinder &amp; Familien",
                "type": "event",
                "invisible": false
            },
            "tipHighlight": false,
            "firstDate": "2018-09-29",
            "lastDate": "2018-09-29"
        },
        {
            "id": "edbed374-e451-447e-bc83-c1b7712c8fde",
            "name": "Event de Test",
            "intro": "",
            "type": "regional",
            "bookingUrl": "textarea",
            "bookingHotline": "test",
            "location": null,
            "host": null,
            "invisible": false,
            "private": false,
            "category": {
                "id": "03d95c3f-7ded-427c-b4f7-102759291761",
                "name": "Kinder &amp; Familien",
                "nameWithParents": "Event \u00bb Kinder &amp; Familien",
                "type": "event",
                "invisible": false
            },
            "tipHighlight": false,
            "firstDate": "2019-06-03",
            "lastDate": "2019-06-22"
        },
        {
            "id": "f4a05703-0e55-4dfa-a0f1-05e837d4f655",
            "name": "Dorffest Mahlberg",
            "intro": "<p>Tolle VA</p>",
            "type": "local",
            "bookingUrl": "",
            "bookingHotline": "",
            "location": 96,
            "host": null,
            "invisible": false,
            "private": false,
            "category": null,
            "tipHighlight": false,
            "firstDate": "2018-07-10",
            "lastDate": "2018-07-27"
        },
        {
            "id": "194c9001-fbe3-4093-b187-5fa15a1f1e9e",
            "name": "EVENT Test der \u00dcbersetzungen",
            "intro": "<p>Deutsche Kurzbeschreibung zum Test der \u00dcbersetzungen bei EVENT.</p><p><strong>Fett</strong>, <em>kursiv</em>, <u>unterstrichen</u>.</p>",
            "type": "local",
            "bookingUrl": "https://www.super-deutsches-buchungssystem.com",
            "bookingHotline": "<p>Hinweistext zur deutschen Buchungshotline zum Test der \u00dcbersetzungen bei EVENT.</p><p><strong>fett</strong>, <em>kursiv</em>, <u>unterstrichen</u>.</p>",
            "location": 167,
            "host": 120,
            "invisible": false,
            "private": false,
            "category": null,
            "tipHighlight": false,
            "firstDate": "2018-09-30",
            "lastDate": "2018-10-02"
        },
        {
            "id": "f22bbeb5-4902-49de-a246-2865beff26b5",
            "name": "Veranstaltung wird an manchen Terminen abgesagt!",
            "intro": "",
            "type": "local",
            "bookingUrl": "",
            "bookingHotline": "",
            "location": 68,
            "host": null,
            "invisible": false,
            "private": false,
            "category": {
                "id": "fa7ae256-7be0-474f-8aa0-af96d168d4cd",
                "name": "Event",
                "nameWithParents": "Event",
                "type": "event",
                "invisible": false
            },
            "tipHighlight": false,
            "firstDate": "2018-08-31",
            "lastDate": "2018-08-31"
        }
    ]
}

event.update

PUT api/v1/event/{event}

Updates the data of the given event. The data must be of the same format as for POST /api/v1/event.

If some attributes are not posted, then they are not updated.

Attributes

name

(string) Name of the event.
eventType

(string) Type of the event.
hasSchedule

(bool) If this event has any dates scheduled.
internalProtocol

(string|null) Internal protocol: Only visible to admins.
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: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
type

(string) Type of the event. Must be one of local, regional, multiregional.
description

(string|null) Free-text description of the event. May contain rich-text.
currentInformation

(string|null) Current information about the event. May contain rich-text.
intro

(string|null) Short intro text about the event. May contain rich-text.
additionalLocationInformation

(string|null) Additional information about the article set as location. This may contain information such as room numbers or section.
additionalMeetingPointInformation

(string|null) Additional information about the article set as meeting point. This may contain information such as room numbers or section.
additionalHostInformation

(string|null) Additional information about the article set as host. This may contain information such as an address or contact. Synchronized events from external sources may not use a related article.
mergeDates

(bool) Whether to merge dates of intervals in the frontend.
canceled

(bool) Whether the event is canceled.
boost

(int) Boost value for result ranking.
author

(string) Display name of author for this item.
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.
category

Associates the event with the given category. The category that is being associated with the event must be of the type event.

The category may be passed in one of the following formats:

  • ID of the category
  • Object containing an id property.

NOTE: When passing an object all properties except the id will be ignored.

Examples

{ "category": 42 }
{ "category": { "id": 12 } }
location

Associates a location with the event. The location is an article that must be of the type point or area.

The location may be provided in one of the following formats:

  • ID of the location
  • Object containing the id property.
  • null to disassociate the current location.

NOTE: When providing an object all properties except the ID will be ignored.

Examples

{ "location": null }
{ "location": { "id": 42 } }
host
files
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 replicatable)
// 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 ] } ]
     }
}
contactInformation

Modifies the contact information related to this article.

Examples

{
     "contactInformation": {
         "twitter": "https://twitter.com/foobar"
     }
}
printInformation

Modifies the print information related to this event.

Examples

{
     "printInformation": {
         "summary": "foo"
     }
}
client

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
syncFiles

Associate files with an item.

  • If a new file should be associated, then the key file must contain the multipart/form-data file upload, or url must reference a URL from which the file can be downloaded.
  • If an existing file is referenced, then the key id must be set.

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": "e37a6365-9e9f-4f1a-858a-c8f94b5a1580",
         "name": "Updated name",
         "description": "Updated description"
     }, {
         "file": "https://placehold.it/500x500"
     }]
}
fillRelatedArticles

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" ]
     }
}
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.
tags

Updates the list of tags that are associated with the item. Tags are passed using an array of strings.

Examples

{
     "tags": [ "foo", "bar", "baz" ],
}
media

Modifies the media elements associated with the item. 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": "ddb6a32e-0a56-4c88-b108-35214b3a9532",
         "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
agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
author

(string) Display name of author for this item.
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" } } } }
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
main

(bool) Set to true if this media is the primary element for the given article/event.
dateIntervals

Updates the date intervals that are associated with the event. Every date interval must have a type set. Additionally, a date and end should be provided.

Provide an id property in order to reuse / update an existing interval. All intervals not in the array will be deleted.

Examples

{
     "dateIntervals": [{
         "type": "daily",
         "date": "2018-12-01",
         "end": "2018-12-24",
         "startAt": "09:00",
         "endAt": "10:00",
         "additionalInformation": "täglicher Adventskreis"
     }, {
         "type": "weekly_day_of_week",
         "date": "2018-01-01",
         "end": "2018-12-31",
         "startAt": "20:00",
         "endAt": "22:00",
         "additionalInformation": "Letzter Sonntag im Monat: Abendveranstaltung",
         "configuration": {
             "days": [ 7 ],
             "week": "last"
     }]
}

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 1 for monday (7 for sunday).
Array Items
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.
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.
bookingRequestUrl

(string|null) The link to a booking request.
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.
seo

Update the seo information of the item.

Examples

{
     "seo": {
         "metaDescription": "A super cool hotel",
         "openGraphDescription": "The best hotel in the world",
         "openGraphTitle": "Hotel Mama",
         "noIndex": false,
         "openGraphImage": { "id": "bd15eaf8-dcd2-4cc3-b528-c83028cefa1a" }
     }
}
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 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.
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,
         "marketingPriceComment": "Lorem ipsum",
         "marketingPrices": [
             [
                 "id": "123-456-789"
                 "currency": "eur"
                 "price": 2.4
             ],
             [
                 "id": "987-654-321"
                 "currency": "chf"
                 "price": 2.5
             ]
         ],
         "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 entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

priceGroups
locationData
Properties
type

(string) The event location type
longitude

(?float)

latitude

(?float)

event
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.
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.
crossiety

(string|null) URL of a crossiety profile.
tiktok

(string|null) URL of a tiktok profile
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.

Examples

$ curl -g -X PATCH \
    -d '{ "name": "UPDATED", "tags": ["foo", "bar", "baz" ] }' \
    'http://toubiz.local/api/v1/event/3df0f504-9112-4fe5-8749-eb8cf14cde36?api_token=admin_token'

{
    "_warning": [],
    "_attributes": {
        "name": "UPDATED",
        "tags": [
            "foo",
            "bar",
            "baz"
        ]
    },
    "_errors": [],
    "payload": {
        "id": "3df0f504-9112-4fe5-8749-eb8cf14cde36 ",
        "name": "UPDATED",
        ...
        "tags": [
            "foo",
            "bar",
            "baz"
        ],
    }
}

# 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/media/18?api_token=admin_token'

{
    "_warning": [],
    "_attributes": { ... },
    "_errors": [],
    "payload": {
        ...
        "media": [
            {
                "id": "3887d650-4086-48fe-8b71-800c82ab3ac0",
                "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/storage/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png",
                "hasCustomCaption": false,
                "description": "",
                "main": false,
                "client": 1,
                "fileType": "PNG"
            }
        ],
    }
}

event.store

POST api/v1/event

Creates a new Event in the database based on the given attributes. The post body may contain any attribute that is also accepted by api.v1.event.update.

Examples

$ curl -g -X POST \
    -d '{ "name": "New event", "type": "local", "category": "660a10b6-7d48-444e-8421-31afcb2ed8fc", "location": "737efb84-6082-4405-b617-ee6a9d7e3964"}' \
    'http://toubiz.local/api/v1/event?api_token=admin_token'

{
   "_warning": [],
   "_attributes": {
       "name": "New event",
       "type": "local",
       "category": "660a10b6-7d48-444e-8421-31afcb2ed8fc",
       "location": "737efb84-6082-4405-b617-ee6a9d7e3964"
   },
   "_errors": [],
   "payload": {
       "id": "1c58fd71-73d8-41eb-8c9a-e43ac18f0837 ",
       "name": "New event",
       "intro": "",
       "type": "local",
       "bookingUrl": "",
       "bookingHotline": "",
       "location": "737efb84-6082-4405-b617-ee6a9d7e3964",
       "host": null,
       "invisible": false,
       "private": false,
       "category": {
           "id": "660a10b6-7d48-444e-8421-31afcb2ed8fc",
           "name": "Kinder &amp; Familien",
           "nameWithParents": "Event \u00bb Kinder &amp; Familien",
           "type": "event",
           "invisible": false
       },
       "tipHighlight": false,
       "firstDate": null,
       "lastDate": null,
       "languages": [
           "de"
       ],
       "permissions": {
           "read": true,
           "write": true,
           "delete": true
       },
       "preview": {
           "image/png": "http://toubiz.local/storage/cache/placeholder/300x200q75.png",
           "image/jpeg": "http://toubiz.local/storage/cache/placeholder/300x200q75.jpg",
           "image/webp": "http://toubiz.local/storage/cache/placeholder/300x200q75.webp"
       },
       "client": "d7c0d44f-32ba-4477-825c-5c993c3c8e56",
       "description": "",
       "generalInformation": "",
       "additionalLocationInformation": "",
       "mergeDates": false,
       "seo": {
           "id": "3df0f504-9112-4fe5-8749-eb8cf14cde36",
           "metaDescription": "",
           "noIndex": false,
           "openGraphDescription": "",
           "openGraphTitle": "",
           "openGraphImage": null
       },
       "price": {
           "freeEntry": false,
           "priceComment": "",
           "priceTable": []
       },
       "internalProtocol": "",
       "files": [],
       "media": [],
       "tags": [],
       "dateIntervals": [
            {
             "type": "none",
             "end": "2020-04-30",
             "date": "2020-04-30",
             "startAt": "20:00:00",
             "endAt": "23:59:00",
             "additionalInformation": ""
            }
        ],
       "links": [],
       "fieldValues": [],
       "fieldBlueprints": []
   }

event.destroy

DELETE api/v1/event/{event}

Delete the specified event.

Examples

$ curl -X DELETE \
    'http://toubiz.local/api/v1/event/2588?api_token=admin_token'

{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": null
}

event.show

GET api/v1/event/{event}

Fetches the details of an event. 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/event/[ID]/files).

Attributes

include[]=files

Also includes the data from the event.files endpoint with the response
include[]=media

Also includes the data from the event.media endpoint with the response
include[]=tags

Also includes the data from the event.tags endpoint with the response
include[]=dates

Also includes the data from the event.dates endpoint with the response
include[]=contactInformation

Also includes the data from the event.contactInformation endpoint with the response
include[]=printInformation

Also includes the data from the event.printInformation endpoint with the response.
include[]=fieldBlueprints

Also includes the data from the event.fieldBlueprints endpoint with the response.

The cache tag uses the action parameter rather than the route parameter because the EventDateController makes a nested call to this action and the route only knows about the eventDate.id.
include[]=fieldValues

Also includes the data from the event.fieldValues endpoint with the response
include[]=externalIds

Also includes the ids from other services for this event
include[]=client

Include a minimal client object instead of the id
include[]=seo

Also includes the data from the event.seo endpoint with the response
include[]=host

Also includes the data from the event.host endpoint with the response
include[]=location

Also includes the data from the event.location endpoint with the response
include[]=category

Also includes the data from the event.category endpoint with the response
include[]=price

Also includes the data from the event.price endpoint with the response
include[]=awardValues

Also includes the data form the event.awardValues endpoint with the response
include[]=awards

Includes the currently valid awards with minimal award blueprint and award set data.

Response

name

(string) Name of the event.
eventType

(string) Type of the event.
hasSchedule

(bool) If this event has any dates scheduled.
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: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
type

(string) Type of the event. Must be one of local, regional, multiregional.
intro

(string|null) Short intro text about the event. May contain rich-text.
mergeDates

(bool) Whether to merge dates of intervals in the frontend.
canceled

(bool) Whether the event is canceled.
onDemand

(bool)

boost

(int) Boost value for result ranking.
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.
accessRestrictions
items
ticketRequired

(string) If a ticket is required.
apiVersion

The API version that this event was created by
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-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.
createdAt

The date at which the event was created.
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

(object) ID of the client or client object to which the event belongs

Properties
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
defaultMapCenterLatitude

(float) Latitude of default map center.
defaultMapCenterLongitude

(float) Longitude of default map center.
owner

(string) Owner of the client.
legalClient

(object) The client handling legal matters (Terms of service, etc.)

Properties
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
integrations
documentation

(object) Data for integration with external services.
defaultLicense
Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
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 1 for monday (7 for sunday).
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.
bookingRequestUrl

(string|null) The link to a booking request.
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.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
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.
webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

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
trashed

(boolean) Indicates whether the item is deleted.
datesCache

(array) READ ONLY. A list of all event dates with only the relevant data.
description

(string|null) Free-text description of the event. May contain rich-text.
currentInformation

(string|null) Current information about the event. May contain rich-text.
additionalLocationInformation

(string|null) Additional information about the article set as location. This may contain information such as room numbers or section.
additionalMeetingPointInformation

(string|null) Additional information about the article set as meeting point. This may contain information such as room numbers or section.
additionalHostInformation

(string|null) Additional information about the article set as host. This may contain information such as an address or contact. Synchronized events from external sources may not use a related article.
auditor

(string)

createdBy

(User|null)

seo

(object) SEO Information of the event

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 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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
secondaryCategories

The secondary categories

Array Items
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

locationData

Raw location data not related to article objects

Array Items
longitude

(?float)

latitude

(?float)

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.
contactInformation
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.
crossiety

(string|null) URL of a crossiety profile.
tiktok

(string|null) URL of a tiktok profile
subject

(HasContactInformationInterface) The item that the contact information are for.
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
vimeoVideo

(string) DEPRECATED, use webMediaLinks
webcam

(string) DEPRECATED, use webMediaLinks
youtubeVideo

(string) DEPRECATED, use webMediaLinks
host

(string) DEPRECATED. ID of the first related host article. Use relatedArticles.hosts instead.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/event/b1e1e5ad-560b-4fdd-ab96-2b4979332adc?api_token=admin_token'

{
   "_warning": [],
   "_attributes": [],
   "_errors": [],
   "payload": {
       "id": "b1e1e5ad-560b-4fdd-ab96-2b4979332adc",
       "name": "Gigantic growler",
       "intro": "<p>Hier steht die deutsche Kurzbeschreibung</p>",
       "type": "regional",
       "bookingUrl": "https://www.super-deutsches-buchungssystem.com",
       "bookingHotline": "test",
       "location": null,
       "host": "737efb84-6082-4405-b617-ee6a9d7e3964",
       "invisible": false,
       "private": false,
       "category": {
           "id": "660a10b6-7d48-444e-8421-31afcb2ed8fc",
           "name": "Kinder &amp; Familien",
           "nameWithParents": "Event \u00bb Kinder &amp; Familien",
           "type": "event",
           "invisible": false
       },
       "tipHighlight": false,
       "firstDate": "2018-09-29",
       "lastDate": "2018-09-29",
       "languages": [
           "de"
       ],
       "permissions": {
           "read": true,
           "write": true,
           "delete": true
       },
       "preview": {
           "image/png": "http://toubiz.local/storage/cache/placeholder/300x200q75.png",
           "image/jpeg": "http://toubiz.local/storage/cache/placeholder/300x200q75.jpg",
           "image/webp": "http://toubiz.local/storage/cache/placeholder/300x200q75.webp"
       },
       "client": 2,
       "description": "<p>Hier steht die deutsche Langbeschreibung.</p>",
       "generalInformation": "",
       "additionalLocationInformation": "",
       "mergeDates": false,
       "seo": {
           "id": "7173e977-fb26-4989-b1cc-4b78e9c682fa",
           "metaDescription": "",
           "noIndex": false,
           "openGraphDescription": "",
           "openGraphTitle": "",
           "openGraphImage": null
       },
       "price": {
           "freeEntry": false,
           "priceComment": "",
           "priceTable": []
       },
       "internalProtocol": ""
   }
}

event.media

GET api/v1/event/{event}/media

Lists all media of the given event.

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 mainImage.sizes key.

Response

(array) Array of media elements containing the following properties

Array Items
agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
agreedUsageRightsBy

(User|null) The user who guaranteed the usage rights.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
checksum

(string) The checksum of the underlying file.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
tags

(array<MediaTag>) Tags can be added to media for special treatment. This can be a a different displaying, no displaying, etc.
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-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/event/b1e1e5ad-560b-4fdd-ab96-2b4979332adc/media?api_token=admin_token'

{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": [
        {
            "id": "ac44261c-1d73-46cf-85d0-eec811fd8aa6",
            "name": "This is a test name",
            "copyright": "",
            "altText": "",
            "caption": "",
            "preview": {
                "image/png": "http://toubiz.local/storage/cache/placeholder/450x300q75.png",
                "image/jpeg": "http://toubiz.local/storage/cache/placeholder/450x300q75.jpg",
                "image/webp": "http://toubiz.local/storage/cache/placeholder/450x300q75.webp"
            },
            "url": null,
            "hasCustomCaption": false,
            "description": "",
            "main": true,
            "client": 2,
            "fileType": ""
        }
    ]
}

event.files

GET api/v1/event/{event}/files

Lists all files of the given event.

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.

Examples

$ curl -X GET 'http://toubiz.local/api/v1/event/b1e1e5ad-560b-4fdd-ab96-2b4979332adc/files?api_token=admin_token'
{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": [
        {
            "id": 134,
            "name": "name test",
            "description": "",
            "url": "https://toubiz.local/storage/files/7eee21fdea18d63db220fd8d6af9b68b__5acc8e101d224.jpeg",
            "preview": {
                "image/png": "http://toubiz.local/storage/cache/file/public/134/7eee21fdea18d63db220fd8d6af9b68b__5acc8e101d224.jpeg/450x300q75.png",
                "image/jpeg": "http://toubiz.local/storage/cache/file/public/134/7eee21fdea18d63db220fd8d6af9b68b__5acc8e101d224.jpeg/450x300q75.jpg",
                "image/webp": "http://toubiz.local/storage/cache/file/public/134/7eee21fdea18d63db220fd8d6af9b68b__5acc8e101d224.jpeg/450x300q75.webp"
            }
        }
    ]
}

event.tags

GET api/v1/event/{event}/tags

event.contactInformation

GET api/v1/event/{event}/contactInformation

Returns the contact information for the current event.

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.
crossiety

(string|null) URL of a crossiety profile.
tiktok

(string|null) URL of a tiktok profile
subject

(HasContactInformationInterface) The item that the contact information are for.
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
vimeoVideo

(string) DEPRECATED, use webMediaLinks
webcam

(string) DEPRECATED, use webMediaLinks
youtubeVideo

(string) DEPRECATED, use webMediaLinks

event.printInformation

GET api/v1/event/{event}/printInformation

Returns the print information for the current event.

Response

active

(bool) Has print Information.
summary

(?string) Summary of the object to print.
description

(?string) Description of the object to print.
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>)

translations

(array<Translatable>)

locale

(string|null)

event.seo

GET api/v1/event/{event}/seo

List of all SEO Information associated with the given article. It is possible to access this information with include=seo on the event.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 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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/event/b1e1e5ad-560b-4fdd-ab96-2b4979332adc/seo?api_token=admin_token'

{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "id": "f65f4568-0f3a-402a-aaba-4a96a2b9d083",
        "metaDescription": "",
        "noIndex": false,
        "openGraphDescription": "",
        "openGraphTitle": "",
        "openGraphImage": null
    }
}

event.host

GET api/v1/event/{event}/host

Fetches information about the hosts of an event. Each host is a POI that organizes the event (e.g. "SV San Flamingo") as opposed to the location which defines the place of the event (e.g. "Stadthalle San Flamingo").

Response

name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.

event.location

GET api/v1/event/{event}/location

Fetches information about the location of an event. The location defines the place of the event (e.g. "Stadthalle San Flamingo") as opposed to the host that organizes the event (e.g. "SV San Flamingo").

Response

name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.

event.category

GET api/v1/event/{event}/category

Returns additional information about the category of the event.

Response

createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

childrenCategories

(object) Categories that are children of the current one.this property is used to build the complete category tree all the way down.

event.client

GET api/v1/event/{event}/client

Returns basic information about the client to which this event belongs.

Response

activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
defaultMapCenterLatitude

(float) Latitude of default map center.
defaultMapCenterLongitude

(float) Longitude of default map center.
owner

(string) Owner of the client.
legalClient

(object) The client handling legal matters (Terms of service, etc.)

Properties
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
integrations
documentation

(object) Data for integration with external services.
defaultLicense
Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd

event.price

GET api/v1/event/{event}/price

Returns information about the events pricing structure.

Response

freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF

event.dates

GET api/v1/event/{event}/dates

Lists all dates of the given event sorted from the first to the last. This also contains evaluated date intervals.

This route is best used with the filter[before] and/or filter[after] request attributes.

Attributes

filter[after]

Filters Events which will take place after the given date
filter[before]

Filters Events which will take place before the given date

Response

(array) Array of EventDates containing the following properties

Array Items
date

(date|null) The date at which the event occurs.
startAt

(string|null) The time at which the event starts (HH:mm).
endAt

(string|null) The time at which the event ends (HH:mm).
joinBefore

(string|null) The last moment a guest can join the event at (HH:mm).
displayDurationAs

(string) The duration can be displayed as a duration or a end time.
additionalInformation

(string) Additional information about the date. May contain rich-text.
isCancelled

(bool) Whether the event has been cancelled at the given date.
bookingRequestUrl

(string|null) The booking request url.
bookingUrl

(string|null) The link to an external booking service.
soldOut

(bool)

active

(bool) If this event date is happening. This might be events dates on a specific date or event dates that are happening on demand. Event dates that are "inactive" should never show up when filtering for a date because they cannot possibly be booked for that date.
area

(string) Location, city display for event.
id

(string|null) The primary UUID
eventLocationAddress

(array) Article address which is set as event location.

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.
marketingPrices

(array) The marketing price in one or more currency.
marketingPriceComment

(string) The marketing price comment.
marketingPricePrefix

(string) The marketing price prefix.

Examples

$ curl -X GET 'http://toubiz.local/api/v1/event/b1e1e5ad-560b-4fdd-ab96-2b4979332adc/dates?api_token=admin_token'
  {
      "_warning": [],
      "_attributes": [],
      "_errors": [],
      "payload": {
          "merged": [
              {
                  "id": 1640,
                  "date": "2018-09-29",
                  "startAt": "10:00:00",
                  "endAt": "12:00:00",
                  "additionalInformation": "test fixed date",
                  "isCancelled": false
              },
              {
                  "id": 11027,
                  "date": "2018-10-01",
                  "startAt": "10:00:00",
                  "endAt": "14:00:00",
                  "additionalInformation": "Every 6 daysHier steht ein deutscher Hinweistext",
                  "isCancelled": false
              },
              {
                  "id": 11028,
                  "date": "2018-10-07",
                  "startAt": "10:00:00",
                  "endAt": "14:00:00",
                  "additionalInformation": "Every 6 daysHier steht ein deutscher Hinweistext",
                  "isCancelled": false
              }
          ],
          "regular": [
              {
                  "id": 1640,
                  "date": "2018-09-29",
                  "startAt": "10:00:00",
                  "endAt": "12:00:00",
                  "additionalInformation": "test fixed date",
                  "isCancelled": false
              }
          ],
          "intervals": [
              {
                  "id": 261,
                  "date": "2018-10-01",
                  "end": "2018-10-12",
                  "startAt": "10:00:00",
                  "endAt": "14:00:00",
                  "type": "daily",
                  "configuration": {
                      "days": [
                          "5",
                          "6"
                      ]
                  },
                  "interval": 6,
                  "additionalInformation": "Hier steht ein deutscher Hinweistext",
                  "disabledDates": []
              }
          ]
      }
  }

eventDate.ics

GET api/v1/eventDate/{eventDate}/ics

eventDate.show

GET api/v1/eventDate/{eventDate}

Fetches the details of an event date.

Response

date

(date|null) The date at which the event occurs.
startAt

(string|null) The time at which the event starts (HH:mm).
endAt

(string|null) The time at which the event ends (HH:mm).
joinBefore

(string|null) The last moment a guest can join the event at (HH:mm).
displayDurationAs

(string) The duration can be displayed as a duration or a end time.
additionalInformation

(string) Additional information about the date. May contain rich-text.
isCancelled

(bool) Whether the event has been cancelled at the given date.
bookingRequestUrl

(string|null) The booking request url.
bookingUrl

(string|null) The link to an external booking service.
soldOut

(bool)

active

(bool) If this event date is happening. This might be events dates on a specific date or event dates that are happening on demand. Event dates that are "inactive" should never show up when filtering for a date because they cannot possibly be booked for that date.
area

(string) Location, city display for event.
id

(string|null) The primary UUID
eventLocationAddress

(array) Article address which is set as event location.

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.
marketingPrices

(array) The marketing price in one or more currency.
marketingPriceComment

(string) The marketing price comment.
marketingPricePrefix

(string) The marketing price prefix.

service.index

GET api/v1/service

Attributes

name

(string)

description

(string)

type

(string)

invisible

(bool)

files
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
syncFiles

Associate files with an item.

  • If a new file should be associated, then the key file must contain the multipart/form-data file upload, or url must reference a URL from which the file can be downloaded.
  • If an existing file is referenced, then the key id must be set.

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": "e37a6365-9e9f-4f1a-858a-c8f94b5a1580",
         "name": "Updated name",
         "description": "Updated description"
     }, {
         "file": "https://placehold.it/500x500"
     }]
}
media

Modifies the media elements associated with the item. 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": "ddb6a32e-0a56-4c88-b108-35214b3a9532",
         "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"
     }]
}
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,
         "marketingPriceComment": "Lorem ipsum",
         "marketingPrices": [
             [
                 "id": "123-456-789"
                 "currency": "eur"
                 "price": 2.4
             ],
             [
                 "id": "987-654-321"
                 "currency": "chf"
                 "price": 2.5
             ]
         ],
         "priceTable": [
             [ "Personengruppe",                 "Preis"     ],
             [ "Kinder bis 6 Jahre",             "kostenlos" ],
             [ "Kinder bis 14 Jahre",            "7 Euro"    ],
             [ "Erwachsene",                     "15 Euro"   ],
             [ "Schüler, Studenten und Rentner", "12 Euro"   ],
         ]
     }
}

Response

(array) Array of objects containing the following properties

Array Items
name

(string)

description

(string)

type

The type of service.

Enum:
  • (string) accommodation
  • (string) various
  • (string) event_location
  • (string) pitch
invisible

(bool)

service.show

GET api/v1/service/{service}

Response

name

(string)

description

(string)

type

The type of service.

Enum:
  • (string) accommodation
  • (string) various
  • (string) event_location
  • (string) pitch
invisible

(bool)

accommodationAspect
documentation

Accommodation specific properties.
item
approvalNumber

(string|null)

minNights

(int|null)

number

(int|null) The number of rooms, apartments, etc.
numberBathrooms

(int|null) The number of bathrooms.
numberBedrooms

(int|null) The number of bedrooms.
numberBeds

(int|null) The number of beds.
occupancyMax

(int|null)

occupancyMin

(int|null)

sizeFrom

(int|null) The smallest accommodation.
sizeTo

(int|null) The biggest accommodation.
type

The type of accommodation.

Enum:
  • (string) room
  • (string) apartment
  • (string) special
selectedValues
documentation

The selected options.
options

Possible options are: {"beds":["oversized","queen_size","french","extra","sofa_bed","single","double","bunk","sofa_bed_double","other"],"bathrooms":["bathroom","shower","bathtub","shared_bathroom","shared_shower","shared_toilet","toilet","separate_toilet","hair_dryer","shower_gel","shampoo","no_running_water","no_hot_water"],"entrance":["ground_floor","separate"],"facilities":["minibar","safe","cd_player","radio","stereo","tv","wifi","phone","air_conditioning","heat"],"laundry":["washing_machine","dryer","flat_iron","laundry_service","sheets","towels","basic_equipment"],"kitchen":["basic_equipment","basic_equipment_cook","basic_equipment_washup","seating_area","eating_area","couch","fireplace","tiled_fireplace","stove","oven","dish_washer","microwave","fridge","freezer","coffee_machine","water_boiler","dishes_cutlery"],"exterior":["patio","balcony","garden_furniture","eating_area"],"view":["lake","mountains","valley","skyline","sea"]}
eventLocationAspect
documentation

Event location specific properties.
item
ceilingHeight

(float|null) The ceiling height in meters.
numberBanquet

(int|null) The number of seats in banquet layout.
numberBlock

(int|null) The number of seats in block layout.
numberHorseShoe

(int|null) The number of seats in horse shoe layout.
numberSeminar

(int|null) The number of seats in seminar layout.
numberStanding

(int|null) The number of places at bar tables.
numberTheater

(int|null) The number of seats in theater layout.
size

(int|null) The room site in square meters.
type

The type of event location.

Enum:
  • (string) auditorium
  • (string) banquet_hall
  • (string) conference_room
  • (string) event_room
  • (string) exhibition_space
  • (string) meeting_room
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>)

selectedValues
documentation

The selected options.
options

Possible options are: {"beds":["oversized","queen_size","french","extra","sofa_bed","single","double","bunk","sofa_bed_double","other"],"bathrooms":["bathroom","shower","bathtub","shared_bathroom","shared_shower","shared_toilet","toilet","separate_toilet","hair_dryer","shower_gel","shampoo","no_running_water","no_hot_water"],"entrance":["ground_floor","separate"],"facilities":["minibar","safe","cd_player","radio","stereo","tv","wifi","phone","air_conditioning","heat"],"laundry":["washing_machine","dryer","flat_iron","laundry_service","sheets","towels","basic_equipment"],"kitchen":["basic_equipment","basic_equipment_cook","basic_equipment_washup","seating_area","eating_area","couch","fireplace","tiled_fireplace","stove","oven","dish_washer","microwave","fridge","freezer","coffee_machine","water_boiler","dishes_cutlery"],"exterior":["patio","balcony","garden_furniture","eating_area"],"view":["lake","mountains","valley","skyline","sea"]}
pitchAspect
documentation

Pitch specific properties.
item
typeOfPlace

(string|null) Type of place.
maxLength

(float|null) The maximum length a vehicle can have.
number

(int|null) The number of places.
size

(int|null) The size from the place.
undergroundOption

(string|null) The texture of the underground.
type

The type of pitch aspect.

Enum:
  • (string) camper_place
  • (string) campsite
selectedValues
documentation

The selected options.
options

Possible options are: {"vehicleType":["caravan","panel_van","vehicle_with_roof_tent","camper","campervan","thick_ships"],"view":["lake","mountains","valley","skyline","sea"]}

service.store

POST api/v1/service

Attributes

name

(string)

description

(string)

type

(string)

invisible

(bool)

files
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
syncFiles

Associate files with an item.

  • If a new file should be associated, then the key file must contain the multipart/form-data file upload, or url must reference a URL from which the file can be downloaded.
  • If an existing file is referenced, then the key id must be set.

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": "e37a6365-9e9f-4f1a-858a-c8f94b5a1580",
         "name": "Updated name",
         "description": "Updated description"
     }, {
         "file": "https://placehold.it/500x500"
     }]
}
media

Modifies the media elements associated with the item. 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": "ddb6a32e-0a56-4c88-b108-35214b3a9532",
         "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"
     }]
}
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,
         "marketingPriceComment": "Lorem ipsum",
         "marketingPrices": [
             [
                 "id": "123-456-789"
                 "currency": "eur"
                 "price": 2.4
             ],
             [
                 "id": "987-654-321"
                 "currency": "chf"
                 "price": 2.5
             ]
         ],
         "priceTable": [
             [ "Personengruppe",                 "Preis"     ],
             [ "Kinder bis 6 Jahre",             "kostenlos" ],
             [ "Kinder bis 14 Jahre",            "7 Euro"    ],
             [ "Erwachsene",                     "15 Euro"   ],
             [ "Schüler, Studenten und Rentner", "12 Euro"   ],
         ]
     }
}

Response

name

(string)

description

(string)

type

The type of service.

Enum:
  • (string) accommodation
  • (string) various
  • (string) event_location
  • (string) pitch
invisible

(bool)

accommodationAspect
documentation

Accommodation specific properties.
item
approvalNumber

(string|null)

minNights

(int|null)

number

(int|null) The number of rooms, apartments, etc.
numberBathrooms

(int|null) The number of bathrooms.
numberBedrooms

(int|null) The number of bedrooms.
numberBeds

(int|null) The number of beds.
occupancyMax

(int|null)

occupancyMin

(int|null)

sizeFrom

(int|null) The smallest accommodation.
sizeTo

(int|null) The biggest accommodation.
type

The type of accommodation.

Enum:
  • (string) room
  • (string) apartment
  • (string) special
selectedValues
documentation

The selected options.
options

Possible options are: {"beds":["oversized","queen_size","french","extra","sofa_bed","single","double","bunk","sofa_bed_double","other"],"bathrooms":["bathroom","shower","bathtub","shared_bathroom","shared_shower","shared_toilet","toilet","separate_toilet","hair_dryer","shower_gel","shampoo","no_running_water","no_hot_water"],"entrance":["ground_floor","separate"],"facilities":["minibar","safe","cd_player","radio","stereo","tv","wifi","phone","air_conditioning","heat"],"laundry":["washing_machine","dryer","flat_iron","laundry_service","sheets","towels","basic_equipment"],"kitchen":["basic_equipment","basic_equipment_cook","basic_equipment_washup","seating_area","eating_area","couch","fireplace","tiled_fireplace","stove","oven","dish_washer","microwave","fridge","freezer","coffee_machine","water_boiler","dishes_cutlery"],"exterior":["patio","balcony","garden_furniture","eating_area"],"view":["lake","mountains","valley","skyline","sea"]}
eventLocationAspect
documentation

Event location specific properties.
item
ceilingHeight

(float|null) The ceiling height in meters.
numberBanquet

(int|null) The number of seats in banquet layout.
numberBlock

(int|null) The number of seats in block layout.
numberHorseShoe

(int|null) The number of seats in horse shoe layout.
numberSeminar

(int|null) The number of seats in seminar layout.
numberStanding

(int|null) The number of places at bar tables.
numberTheater

(int|null) The number of seats in theater layout.
size

(int|null) The room site in square meters.
type

The type of event location.

Enum:
  • (string) auditorium
  • (string) banquet_hall
  • (string) conference_room
  • (string) event_room
  • (string) exhibition_space
  • (string) meeting_room
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>)

selectedValues
documentation

The selected options.
options

Possible options are: {"beds":["oversized","queen_size","french","extra","sofa_bed","single","double","bunk","sofa_bed_double","other"],"bathrooms":["bathroom","shower","bathtub","shared_bathroom","shared_shower","shared_toilet","toilet","separate_toilet","hair_dryer","shower_gel","shampoo","no_running_water","no_hot_water"],"entrance":["ground_floor","separate"],"facilities":["minibar","safe","cd_player","radio","stereo","tv","wifi","phone","air_conditioning","heat"],"laundry":["washing_machine","dryer","flat_iron","laundry_service","sheets","towels","basic_equipment"],"kitchen":["basic_equipment","basic_equipment_cook","basic_equipment_washup","seating_area","eating_area","couch","fireplace","tiled_fireplace","stove","oven","dish_washer","microwave","fridge","freezer","coffee_machine","water_boiler","dishes_cutlery"],"exterior":["patio","balcony","garden_furniture","eating_area"],"view":["lake","mountains","valley","skyline","sea"]}
pitchAspect
documentation

Pitch specific properties.
item
typeOfPlace

(string|null) Type of place.
maxLength

(float|null) The maximum length a vehicle can have.
number

(int|null) The number of places.
size

(int|null) The size from the place.
undergroundOption

(string|null) The texture of the underground.
type

The type of pitch aspect.

Enum:
  • (string) camper_place
  • (string) campsite
selectedValues
documentation

The selected options.
options

Possible options are: {"vehicleType":["caravan","panel_van","vehicle_with_roof_tent","camper","campervan","thick_ships"],"view":["lake","mountains","valley","skyline","sea"]}

service.update

PUT api/v1/service/{service}

Attributes

name

(string)

description

(string)

type

(string)

invisible

(bool)

files
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
syncFiles

Associate files with an item.

  • If a new file should be associated, then the key file must contain the multipart/form-data file upload, or url must reference a URL from which the file can be downloaded.
  • If an existing file is referenced, then the key id must be set.

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": "e37a6365-9e9f-4f1a-858a-c8f94b5a1580",
         "name": "Updated name",
         "description": "Updated description"
     }, {
         "file": "https://placehold.it/500x500"
     }]
}
media

Modifies the media elements associated with the item. 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": "ddb6a32e-0a56-4c88-b108-35214b3a9532",
         "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"
     }]
}
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,
         "marketingPriceComment": "Lorem ipsum",
         "marketingPrices": [
             [
                 "id": "123-456-789"
                 "currency": "eur"
                 "price": 2.4
             ],
             [
                 "id": "987-654-321"
                 "currency": "chf"
                 "price": 2.5
             ]
         ],
         "priceTable": [
             [ "Personengruppe",                 "Preis"     ],
             [ "Kinder bis 6 Jahre",             "kostenlos" ],
             [ "Kinder bis 14 Jahre",            "7 Euro"    ],
             [ "Erwachsene",                     "15 Euro"   ],
             [ "Schüler, Studenten und Rentner", "12 Euro"   ],
         ]
     }
}

Response

name

(string)

description

(string)

type

The type of service.

Enum:
  • (string) accommodation
  • (string) various
  • (string) event_location
  • (string) pitch
invisible

(bool)

accommodationAspect
documentation

Accommodation specific properties.
item
approvalNumber

(string|null)

minNights

(int|null)

number

(int|null) The number of rooms, apartments, etc.
numberBathrooms

(int|null) The number of bathrooms.
numberBedrooms

(int|null) The number of bedrooms.
numberBeds

(int|null) The number of beds.
occupancyMax

(int|null)

occupancyMin

(int|null)

sizeFrom

(int|null) The smallest accommodation.
sizeTo

(int|null) The biggest accommodation.
type

The type of accommodation.

Enum:
  • (string) room
  • (string) apartment
  • (string) special
selectedValues
documentation

The selected options.
options

Possible options are: {"beds":["oversized","queen_size","french","extra","sofa_bed","single","double","bunk","sofa_bed_double","other"],"bathrooms":["bathroom","shower","bathtub","shared_bathroom","shared_shower","shared_toilet","toilet","separate_toilet","hair_dryer","shower_gel","shampoo","no_running_water","no_hot_water"],"entrance":["ground_floor","separate"],"facilities":["minibar","safe","cd_player","radio","stereo","tv","wifi","phone","air_conditioning","heat"],"laundry":["washing_machine","dryer","flat_iron","laundry_service","sheets","towels","basic_equipment"],"kitchen":["basic_equipment","basic_equipment_cook","basic_equipment_washup","seating_area","eating_area","couch","fireplace","tiled_fireplace","stove","oven","dish_washer","microwave","fridge","freezer","coffee_machine","water_boiler","dishes_cutlery"],"exterior":["patio","balcony","garden_furniture","eating_area"],"view":["lake","mountains","valley","skyline","sea"]}
eventLocationAspect
documentation

Event location specific properties.
item
ceilingHeight

(float|null) The ceiling height in meters.
numberBanquet

(int|null) The number of seats in banquet layout.
numberBlock

(int|null) The number of seats in block layout.
numberHorseShoe

(int|null) The number of seats in horse shoe layout.
numberSeminar

(int|null) The number of seats in seminar layout.
numberStanding

(int|null) The number of places at bar tables.
numberTheater

(int|null) The number of seats in theater layout.
size

(int|null) The room site in square meters.
type

The type of event location.

Enum:
  • (string) auditorium
  • (string) banquet_hall
  • (string) conference_room
  • (string) event_room
  • (string) exhibition_space
  • (string) meeting_room
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>)

selectedValues
documentation

The selected options.
options

Possible options are: {"beds":["oversized","queen_size","french","extra","sofa_bed","single","double","bunk","sofa_bed_double","other"],"bathrooms":["bathroom","shower","bathtub","shared_bathroom","shared_shower","shared_toilet","toilet","separate_toilet","hair_dryer","shower_gel","shampoo","no_running_water","no_hot_water"],"entrance":["ground_floor","separate"],"facilities":["minibar","safe","cd_player","radio","stereo","tv","wifi","phone","air_conditioning","heat"],"laundry":["washing_machine","dryer","flat_iron","laundry_service","sheets","towels","basic_equipment"],"kitchen":["basic_equipment","basic_equipment_cook","basic_equipment_washup","seating_area","eating_area","couch","fireplace","tiled_fireplace","stove","oven","dish_washer","microwave","fridge","freezer","coffee_machine","water_boiler","dishes_cutlery"],"exterior":["patio","balcony","garden_furniture","eating_area"],"view":["lake","mountains","valley","skyline","sea"]}
pitchAspect
documentation

Pitch specific properties.
item
typeOfPlace

(string|null) Type of place.
maxLength

(float|null) The maximum length a vehicle can have.
number

(int|null) The number of places.
size

(int|null) The size from the place.
undergroundOption

(string|null) The texture of the underground.
type

The type of pitch aspect.

Enum:
  • (string) camper_place
  • (string) campsite
selectedValues
documentation

The selected options.
options

Possible options are: {"vehicleType":["caravan","panel_van","vehicle_with_roof_tent","camper","campervan","thick_ships"],"view":["lake","mountains","valley","skyline","sea"]}

service.destroy

DELETE api/v1/service/{service}

category.index

GET api/v1/category

Retrieve the category tree. This view is heavily cached. New categories may not appear in this endpoint until a couple of minutes after their creation.

NOTE: This method will only show the categories that the current user has access to.

Response

(array) Array of categories containing the following properties

Array Items
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

childrenCategories

(object) Categories that are children of the current one.this property is used to build the complete category tree all the way down.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/category?api_token=admin_token'

{
  "_warning": [],
  "_attributes": [],
  "_errors": [],
  "payload": [
    {
      "id": "447715ab-c4fb-4dd6-82fa-8f78f5fa3ec3",
      "name": "\u00dcbernachten",
      "nameWithParents": "\u00dcbernachten",
      "type": "point",
      "invisible": false,
      "childrenCategories": [
        {
          "id": "72ab4a5a-2c8d-4f65-8e2d-5db20d068caa",
          "name": "Hotel",
          "nameWithParents": "\u00dcbernachten \u00bb Hotel",
          "type": "point",
          "invisible": false,
          "childrenCategories": [
            {
              "id": "7f678d72-999e-4c4b-bbdc-a2e127451033",
              "name": "Hotel Garni",
              "nameWithParents": "\u00dcbernachten \u00bb Hotel \u00bb Hotel Garni",
              "type": "point",
              "invisible": false,
              "childrenCategories": []
            },
            {
              "id": "ee5d2b09-2f9a-4f7b-a645-13b9f3ea6961",
              "name": "Kurhotel",
              "nameWithParents": "\u00dcbernachten \u00bb Hotel \u00bb Kurhotel",
              "type": "point",
              "invisible": false,
              "childrenCategories": []
            },
            {
              "id": "7998ac9e-f722-41e1-88c2-27d3925b31cd",
              "name": "Motel",
              "nameWithParents": "\u00dcbernachten \u00bb Hotel \u00bb Motel",
              "type": "point",
              "invisible": false,
              "childrenCategories": []
            },
            {
              "id": "af9877aa-e65d-4c25-862f-2bb32822eb71",
              "name": "Seminar-/Tagungshotel",
              "nameWithParents": "\u00dcbernachten \u00bb Hotel \u00bb Seminar-/Tagungshotel",
              "type": "point",
              "invisible": false,
              "childrenCategories": []
            },
            {
              "id": "32546fa4-fb9c-4a85-ad76-c016f0f593c4",
              "name": "Apart-/Apartmenthotel",
              "nameWithParents": "\u00dcbernachten \u00bb Hotel \u00bb Apart-/Apartmenthotel",
              "type": "point",
              "invisible": false,
              "childrenCategories": []
            },
            {
              "id": "fdb39b74-fcda-485b-9a07-0d7389001090",
              "name": "Hotel",
              "nameWithParents": "\u00dcbernachten \u00bb Hotel \u00bb Hotel",
              "type": "point",
              "invisible": false,
              "childrenCategories": []
            }
          ]
        },
        {
          "id": "61c886d6-ffbc-4202-bfa2-5c9b4ada6e26",
          "name": "Camping",
          "nameWithParents": "\u00dcbernachten \u00bb Camping",
          "type": "point",
          "invisible": false,
          "childrenCategories": [
            {
              "id": "4f306107-4f39-41c3-9375-72e9472119d8",
              "name": "Campingplatz",
              "nameWithParents": "\u00dcbernachten \u00bb Camping / Caravan \u00bb Campingplatz",
              "type": "point",
              "invisible": false,
              "childrenCategories": []
            },
            {
              "id": "357f3127-72da-4d91-aa96-e13ab9fa1f7f",
              "name": "Reisemobilstellplatz",
              "nameWithParents": "\u00dcbernachten \u00bb Camping / Caravan \u00bb Reisemobilstellplatz",
              "type": "point",
              "invisible": false,
              "childrenCategories": []
            }
          ]
        }
      ]
    }
  ]
}

category.show

GET api/v1/category/{category}

Gets the detailed data about a category. This endpoint will only return a category if the current user has access to it.

Attributes

minimal

Can be specified to only retrieve minimal data about the category without any relationship information.

Response

createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

childrenCategories

(array) The categories that are direct children of the current category (not deep)

Array Items
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

createdAt

(string) The date & time when the category was created (YYYY-MM-DD\THH:mm:ss)
fieldBlueprints

(array) Array of all field groups (including general, specific and highlight) that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

languages

(string[]) All languages in which the category is available
locale

(string) The current language of the category
parentCategory

(object) The category that is above the current one in the tree

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

updatedAt

(string) The date & time when the category was last edited (YYYY-MM-DD\THH:mm:ss)

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/category/4f306107-4f39-41c3-9375-72e9472119d8?api_token=admin_token'

{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "id": "4f306107-4f39-41c3-9375-72e9472119d8",
        "name": "Campingplatz",
        "nameWithParents": "\u00dcbernachten \u00bb Camping / Caravan \u00bb Campingplatz",
        "type": "point",
        "invisible": false,
        "fieldBlueprints": [],
        "parentCategory": {
            "id": "61c886d6-ffbc-4202-bfa2-5c9b4ada6e26",
            "name": "Camping",
            "nameWithParents": "\u00dcbernachten \u00bb Camping",
            "type": "point",
            "invisible": false
        },
        "childrenCategories": [],
        "languages": [
            "de"
        ],
        "locale": "de",
        "createdAt": "2019-06-12T17:18:53",
        "updatedAt": "2019-08-24T11:35:10"
    }
}

client.index

GET api/v1/client

Lists all clients.

Attributes

pagination[page]

The page number that is currently being visited.
pagination[pageSize]

Size of each page.
minimal

If set to 1 then the payload is only a simple (unpaginated) mapping of id => name.

Response

(array) Array of objects containing the following properties

Array Items
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
defaultMapCenterLatitude

(float) Latitude of default map center.
defaultMapCenterLongitude

(float) Longitude of default map center.
owner

(string) Owner of the client.
legalClient

(object) The client handling legal matters (Terms of service, etc.)

Properties
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
integrations
documentation

(object) Data for integration with external services.
defaultLicense
Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd

Examples

curl -g -X GET \
    'http://toubiz.local/api/v1/client?pagination[pageSize]=3&api_token=admin_token'

{
    "_warning": [],
    "_attributes": {
        "pagination": { "pageSize": "3"  }
    },
    "_errors": [],
    "payload": [{
        "id": 1,
        "name": "Test Client",
        "owner": "Testtest",
        "url": "http://test.com/",
        "logo": null
    },{
        "id": 2,
        "name": "Th\u00fcringer Tourismus GmbH",
        "owner": "",
        "url": "http://www.entenhausen.de",
        "logo": null
    },{
        "id": 27,
        "name": "test",
        "owner": "",
        "url": "",
        "logo": null
    }]
}

curl -g -X GET \
    'http://toubiz.local/api/v1/client?minimal=1&api_token=admin_token'

{
    "_warning": [],
    "_attributes": {
        "pagination": { "pageSize": "3"  }
    },
    "_errors": [],
    "payload": {
        1: "Test Client",
        2: "Th\u00fcringer Tourismus GmbH",
        27: "test",
        ...
    }
}

media.index

GET api/v1/media

Lists all media objects.

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.
applyChannelToQuery
search
filter[used]

Filters for the usage of the media element.

Maybe a string or an array of strings containing the following options:

  • article: Only return the media elements that are used in articles
  • event: Only return the media element that are used in events.
filter[main]

Only returns media elements that are used as main images in either events or articles.

Examples

// Get all main images of articles
$ curl http://toubiz.local/api/v1/media?filter[main]=1&filter[used]=article
filter[uploadedBy]

Allows filtering for the id of the uploading user.

If multiple users should be filtered for then the following formats may be provided:

  • array of ids
  • comma separated ids.
filter[withHiddenMedia]

Include hidden media.
sorting

Sorts the return value by the given property and direction.

This attribute is expected to be an array containing the following keys:

  • sorting[property]: The property that should be sorted by. The following properties may be used for sorting: name, copyright, altText, createdAt, updatedAt. Defaults to createdAt.
  • sorting[direction]: The direction of sorting. Can be either asc or desc. Defaults to asc.
filter[license]

Filters media by license.

This property can either contain a comma-separated string of licenses or just one license.

Examples

$ curl http://toubiz.local/api/v1/media?filter[license][0]=cc-by&filter[license][1]=cc-by-sa
$ curl http://toubiz.local/api/v1/media?filter[license]=cc-by,cc-by-sa
filter[fromDataPool]

Filter media from data pool.

This will return all the media from other clients with all licenses except none.
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.

Response

(array) Array of media elements containing the following properties

Array Items
agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
agreedUsageRightsBy

(User|null) The user who guaranteed the usage rights.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
checksum

(string) The checksum of the underlying file.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
tags

(array<MediaTag>) Tags can be added to media for special treatment. This can be a a different displaying, no displaying, etc.
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-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://localhost:8000/api/v1/media?api_token=TOKEN`

```
{
     "_warning": [ ],
     "errors": [ ],
     "attributes": {
         "api_token": "TOKEN"
     },
     "payload": [{
         "id": 20,
         "name": "wolkenhimmel",
         "copyright": "@unsplash",
         "altText": "Wolkenhimmel und Berge",
         "preview": {
             "image/webp": "http://toubiz.test/storage/cache/placeholder/450x300q75.webp",
             "image/jpeg": "http://toubiz.test/storage/cache/placeholder/450x300q75.jpg"
         },
         "description": ""
     }]
}
```

media.show

GET api/v1/media/{medium}

Fetch a media object.

Attributes

include[]=languages

Includes language details in the response
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.

Examples

`$ curl -X GET http://localhost:8000/api/v1/article/1?api_token=TOKEN`

```
{
     "_warning": [ ],
     "errors": [ ],
     "attributes": {
         "api_token": "TOKEN"
     },
     "payload": [{
         "id": 20,
         "name": "wolkenhimmel",
         "copyright": "@unsplash",
         "altText": "Wolkenhimmel und Berge",
         "preview": {
             "image/webp": "http://toubiz.test/storage/cache/placeholder/450x300q75.webp",
             "image/jpeg": "http://toubiz.test/storage/cache/placeholder/450x300q75.jpg"
         },
         "description": ""
     }]
}
```

media.update

PUT api/v1/media/{medium}

Updates an existing media object in the database. The data structure that must be given as POST Body is the same as for the store route.

Attributes

agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
author

(string) Display name of author for this item.
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" } } } }
client

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
main

(bool) Set to true if this media is the primary element for the given article/event.

media.updateByExternalId

POST api/v1/media/externalId/{id}

Update a media item based on its external id for a specific service. Useful for updating translated information when you do not know the id of an item. mein.toubiz.de/api/v1/media/externalId/foo-1234?service=toubizLegacy&language=en&api_token=API_TOKEN

Attributes

agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
author

(string) Display name of author for this item.
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" } } } }
client

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
main

(bool) Set to true if this media is the primary element for the given article/event.

Examples

<caption>Example payload for creating a media object:</caption>
{
    "name": "This is a test name",
    "altText": "Some alt text",
    "copyright": "Copyright: test",
    "locale": "en"
}

media.store

POST api/v1/media

Creates a new media object with the given attributes. The request must contain the following attributes:

The following attributes may be given:

The following attributes must not be given:

If the posting user is an admin, then he also must provide the client attribute containing the ID of the client which is associated with the media element.

Attributes

agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
author

(string) Display name of author for this item.
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" } } } }
client

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
main

(bool) Set to true if this media is the primary element for the given article/event.

Examples

<caption>Example payload for creating a media object:</caption>
{
    "name": "This is a test name",
    "altText": "Some alt text",
    "copyright": "Copyright: test",
}

media.destroy

DELETE api/v1/media/{medium}

Delete the specified media when they aren't related objects (articles or events) anymore.

Attributes

agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
description

(string) General description of the image.
latitude

(float) Latitude
longitude

(float) Longitude
name

(string) Name of the media element.
showInMediaLibrary

(bool) Show media in the media library.
author

(string) Display name of author for this item.
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" } } } }
client

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }
externalIds

Adds external ids to an item using a service->value syntax. value must allow unambiguous assignment in the entire service. To delete an external id pass null as a value.

Examples

{
     "externalIds": {
         "my-external-service": "uuid-123-456",
         "my-other-external-service": "context_id/item_id",
         "my-old-service": null
     }
}
main

(bool) Set to true if this media is the primary element for the given article/event.

media.relations

GET api/v1/media/{id}/relations

Returns information about all entities that are related to the given media element.

Response

articles

(object<string, string>) Map of id => name mapping of related articles
events

(object<string, string>) Map of id => name mapping of related events

Examples

$ curl -X GET http://localhost:8000/api/v1/article/006e3a3d-2d56-3d4e-8dfe-01e78fa65719/relations?api_token=TOKEN

{
     "_warning": [],
     "_attributes": { },
     "_errors": [ ],
     "payload": {
     "articles": {
         "7ecbe631-475e-3afc-b901-6fb61eddaf1b": "Golf de Sarreguemines"
     },
     "events": { }
}

tag.index

GET api/v1/tag

Lists all tags as a simple array of strings. This response is heavily cached, so new tags may not be available right away.

Examples

`$ curl -X GET http://toubiz.local/api/v1/tag?api_token=TOKEN`

```
{
     "_warning": [ ],
     "attributes": { },
     "errors": [ ],
     "payload": [
         "la",
         "le",
         "li",
         "lo",
         "lu",
         "foo",
         "bar",
         "baz"
     ]
}
```

collection.index

GET api/v1/collection

Shows a list of all collections belonging to the current client.

Attributes

search
filter[type]

Only returns the collections of a certain type (article or events).
sorting

Allows to sort collection 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.
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.

Response

(array) Array of objects containing the following properties

Array Items
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.

Examples

$ curl -X GET 'http://toubiz.local/api/v1/collection?api_token=user_token'
{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": [
        {
            "id": "9fb96aa9-3262-41f7-bb69-3cbd90eab44a",
            "name": "test",
            "type": "article",
            "articles": [ "735074be-079f-4770-9057-16cb6bdebfe1" ]
        },
        {
            "id": "cefec8ae-d338-4f43-8b18-8d259055a792",
            "name": "test 2",
            "type": "event",
            "events": [
                "696a589e-07af-434e-b600-9722bdd3d44d",
                "2fd71507-5d54-443a-b891-915db1a64c67"
            ]
        }
    ]
}

collection.show

GET api/v1/collection/{collection}

Displays detail data about the given collection.

Response

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.

Examples

$ curl -X GET 'http://toubiz.local/api/v1/collection/1?api_token=user_token'
{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "id": "9fb96aa9-3262-41f7-bb69-3cbd90eab44a",
        "name": "test",
        "type": "article",
        "articles": [
            "735074be-079f-4770-9057-16cb6bdebfe1"
        ]
    }
}

collection.update

PUT api/v1/collection/{collection}

Updates the attributes of the given collection.

Attributes

name

(string) Name of the collection.
topline

(string) A topline for displaying above the title.
license

(string)

description

(string)

articles

Allows associating the articles with the given ids with the collection. NOTE: This only works for ArticleCollection.

Examples

{ "articles": [ 2, 4, 5 ] }
events

Allows associating the events with the given ids with the collection. NOTE: This only works for EventCollection.

Examples

{ "events": [ 12, 34, 45 ] }
image

Sets the logo on the current client. The logo can be either a reference to an existing file (using an object with the id property) or a newly uploaded file (submitted via multipart/form-data file upload).
client

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }
fillImage

Sets the 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.

Examples

$ curl -X POST 'http://toubiz.local/api/v1/collection/9fb96aa9-3262-41f7-bb69-3cbd90eab44a?api_token=user_token'
    -d '{ "name": "updated" }'

{
    "_warning": [],
    "_attributes": {
        "name": "updated"
    },
    "_errors": [],
    "payload": {
        "id": "9fb96aa9-3262-41f7-bb69-3cbd90eab44a",
        "name": "updated",
        "type": "article",
        "articles": [ "735074be-079f-4770-9057-16cb6bdebfe1" ]
    }
}

collection.store

POST api/v1/collection

Creates a new collection. This endpoint accepts all of the same attributes as the api.v1.collection.update endpoint.

Examples

$ curl -X POST 'http://toubiz.local/api/v1/collection?api_token=user_token'
    -d '{ "name": "test 2", "type": "event", "events": ["696a589e-07af-434e-b600-9722bdd3d44d", "2fd71507-5d54-443a-b891-915db1a64c67" ] }'

{
    "_warning": [],
    "_attributes": {
        "name": "test 2",
        "type": "event",
        "events": [
             "696a589e-07af-434e-b600-9722bdd3d44d",
             "2fd71507-5d54-443a-b891-915db1a64c67"
         ]
    },
    "_errors": [],
    "payload": {
        "id": "ab2ce370-5f41-4907-b229-4520260fb6cd",
        "name": "test 2",
        "type": "event",
        "events": [
            "696a589e-07af-434e-b600-9722bdd3d44d",
            "2fd71507-5d54-443a-b891-915db1a64c67"
         ]
    }
}

collection.destroy

DELETE api/v1/collection/{collection}

Removes the given collection from the database.

collection.article.add

POST api/v1/collection/{collection}/article/{article}

Adds the article with the given id to the collection with the given id. NOTE: The collection must be an ArticleCollection in order to use this endpoint.

Examples

$ curl -X POST 'http://toubiz.local/api/v1/collection/1/article/72?api_token=user_token'
{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "id": 1,
        "name": "updated",
        "type": "article",
        "articles": [ 9, 72 ]
    }
}

collection.article.remove

DELETE api/v1/collection/{collection}/article/{article}

Removes the article with the given id from the collection with the given id. NOTE: The collection must be an ArticleCollection in order to use this endpoint.

Examples

$ curl -X DELETE 'http://toubiz.local/api/v1/collection/1/article/72?api_token=user_token'
{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "id": 1,
        "name": "updated",
        "type": "article",
        "articles": [ 9 ]
    }
}

collection.event.add

POST api/v1/collection/{collection}/event/{event}

Adds the event with the given id to the collection with the given id. NOTE: The collection must be an EventCollection in order to use this endpoint.

Examples

$ curl -X POST 'http://toubiz.local/api/v1/collection/2/event/19?api_token=user_token'
{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "id": 2,
        "name": "test 2",
        "type": "event",
        "events": [ 2, 4, 19 ]
    }
}

collection.event.remove

DELETE api/v1/collection/{collection}/event/{event}

Removes the event with the given id from the collection with the given id. NOTE: The collection must be an EventCollection in order to use this endpoint.

Examples

$ curl -X DELETE 'http://toubiz.local/api/v1/collection/2/event/19?api_token=user_token'
{
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "id": 2,
        "name": "test 2",
        "type": "event",
        "events": [ 2, 4 ]
    }
}

audit.show

GET api/v1/audit/{type}/{id}/{version}

site.index

GET api/v1/site

Attributes

offline

Also includes the sites that are set to 'offline' with the result.
sorting
search
filterCategory
filterCategoryWithSecondary
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.

Response

(array) Array of objects containing the following properties

Array Items
name

(string) Name / Title of the site
isOffline

(bool) Whether the site is marked to be offline.
domains

(array) Domains associated with the site.

Array Items
domainName

(string) Domain name (without protocol).

site.show

GET api/v1/site/{site}

Response

name

(string) Name / Title of the site
isOffline

(bool) Whether the site is marked to be offline.
domains

(array) Domains associated with the site.

Array Items
domainName

(string) Domain name (without protocol).
apiUser

(string) ID of the API-User associated with the site.
article
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
configuration

(object) Arbitrary configuration
metaDescription

(string) Meta description
favicon

(string) The favicon

site.store

POST api/v1/site

Attributes

article

ID of the article that should be associated with the new site.
name

(string)

alternativeTitle

(string)

configuration

(stdClass)

primaryColor

(string)

logoSize

(string)

metaDescription

(string)

isOffline

(bool)

originalClient

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }

Response

name

(string) Name / Title of the site
isOffline

(bool) Whether the site is marked to be offline.
domains

(array) Domains associated with the site.

Array Items
domainName

(string) Domain name (without protocol).
apiUser

(string) ID of the API-User associated with the site.
article
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
configuration

(object) Arbitrary configuration
metaDescription

(string) Meta description
favicon

(string) The favicon

site.update

PUT api/v1/site/{site}

Attributes

name

(string)

alternativeTitle

(string)

configuration

(stdClass)

primaryColor

(string)

logoSize

(string)

metaDescription

(string)

isOffline

(bool)

originalClient

Associates a client with the item. The client may be passed in one of the following formats:

  • ID of the client
  • Object containing the id property

NOTE: When passing an object all properties but the ID will be ignored.

This attribute can only be provided by admins or managers. Non-admins users will not be able to set the client on an item manually: It will always be set to the client they belong to.

{ "client": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1" }
{ "client": { "id": "d8a1d47d-3192-4d8e-bf80-1b4d1404f8d1", ... } }

Response

name

(string) Name / Title of the site
isOffline

(bool) Whether the site is marked to be offline.
domains

(array) Domains associated with the site.

Array Items
domainName

(string) Domain name (without protocol).
apiUser

(string) ID of the API-User associated with the site.
article
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipPublicTransport

(bool) Tip: Public Transport
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
createdBy

(User|null)

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|string|null) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
clusterNative

(string|null) The cluster that this and all child categories will belong to. Clusters should match the "mainTypes" from the Neos integration. Check toubiz-frontend:Newland\Toubiz\Sync\Neos\Enum\ArticleType for available values:

  • cities, poi, gastronomy, lodgings, tours, directMarketers, congressLocations
cluster

(string|null) [READONLY] The cluster, defined by itself or a parent category.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
description

(string)

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.
icon

(string) An icon to represent the field set.
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
certifiedBy

(string)

certifiedByUrl

(string)

description

(string)

domain

(string) The use case of this award set ("award", "card", "membership", etc.)
title

(string)

image

(File|null)

icon

(string)

invisible

(bool)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string) If the award values can be quantified, it is a "classification", otherwise it is an "award"
topic

(string)

criteria

(string)

scope

(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>)

translations

(array<Translatable>)

locale

(string|null)

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
activationDate

(date|null)

cost

(float)

crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
customerNumber

(string|null)

email

(string)

factor

(float) How much the customer pays for the license.
inactive

(bool)

internalNote

(string)

internalNoteForAdmins

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
name

(string) Name of the client.
phoneNumber

(string)

plan

(string) Which license model the customer has with us.
title

(string)

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.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPricePrefix

(string)

marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
image

(File|null)

type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
configuration

(object) Arbitrary configuration
metaDescription

(string) Meta description
favicon

(string) The favicon

site.destroy

DELETE api/v1/site/{site}