Returns a list of BaseBookable objects with given self-service access scope

GET /api/event/base_bookable_for_self_service_scope/{scope}

Path parameters

  • scope string Required

Query parameters

  • name string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • token string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • baseLocation string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • bookableType string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • slugIdentifier string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • addressStreetLevel string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • addressCity string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • addressZip string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • addressCountry string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • addressGeoLat string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • addressGeoLng string

    Requires access right: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE

  • id integer

    Requires access right: SCOPE

  • deleted boolean

    This property is used to mark an entity as deleted / archived | Requires access right: SCOPE

  • searchString string

    text to search for in the list

  • orderFieldName string

    name of the order field

  • orderFieldSort string

    sorting mode

    Values are DESC or ASC.

  • page integer

    page of the list

    Default value is 0.

  • pageSize integer

    number of entries for each page

    Minimum value is 1, maximum value is 200. Default value is 50.

  • withMaxPageNumber string

    returns the number of pages available as a header if this is set

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

Responses

  • 200 application/json

    Returns a list of BaseBookable objects with given self-service access scope

    Hide response attributes Show response attributes object
    • baseLocation object
      Hide baseLocation attributes Show baseLocation attributes object
      • id integer
      • token string
      • location_type string
      • created string(date-time)
      • updated string(date-time)
      • address string
      • address_street string
      • address_house_number string
      • address_street_level string
      • address_co string
      • address_city string
      • address_zip string
      • address_admin_level1 string
      • address_country string
      • address_full_country string
      • address_geo_lat string
      • address_geo_lng string
      • address_external_provider_id string
      • main_phone string
      • main_fax string
      • main_email string
      • website string
      • name string
      • deleted boolean
      • short_identifier string
      • image_url string
      • slug_identifier string
      • opening_hours_monday string
      • opening_hours_tuesday string
      • opening_hours_wednesday string
      • opening_hours_thursday string
      • opening_hours_friday string
      • opening_hours_saturday string
      • opening_hours_sunday string
      • is_ui_filter boolean
      • unified_cat_ids object

        Additional properties are allowed.

      • unified_cat_names object

        Additional properties are allowed.

    • id integer
    • token string
    • bookable_type string
    • floor_level string
    • floor_size integer
    • pets_allowed boolean
    • barrier_free boolean
    • cargo_volume integer
    • fuel_type string
    • seating_capacity integer
    • has_wait_list boolean
    • booking_limit integer
    • new_booking_only_in_blocks boolean
    • new_booking_only_in_opening_hours boolean
    • new_booking_only_in_self_service_opening_hours boolean
    • new_booking_limit_days_before integer
    • new_booking_limit_stop_days_before integer
    • delete_booking_hours_before integer
    • block_length integer
    • new_booking_min_length integer
    • new_booking_max_length integer
    • require_address boolean
    • require_contact boolean
    • require_billing boolean
    • require_booking_title boolean
    • allow_direct_billing boolean
    • require_age boolean
    • age_group string
    • min_age integer
    • max_age integer
    • age_tolerance integer
    • created string(date-time)
    • updated string(date-time)
    • address string
    • address_street string
    • address_house_number string
    • address_street_level string
    • address_co string
    • address_city string
    • address_zip string
    • address_admin_level1 string
    • address_country string
    • address_full_country string
    • address_geo_lat string
    • address_geo_lng string
    • address_external_provider_id string
    • main_phone string
    • main_fax string
    • main_email string
    • website string
    • name string
    • deleted boolean
    • short_identifier string
    • image_url string
    • slug_identifier string
    • opening_hours_monday string
    • opening_hours_tuesday string
    • opening_hours_wednesday string
    • opening_hours_thursday string
    • opening_hours_friday string
    • opening_hours_saturday string
    • opening_hours_sunday string
    • self_service_opening_hours_monday string
    • self_service_opening_hours_tuesday string
    • self_service_opening_hours_wednesday string
    • self_service_opening_hours_thursday string
    • self_service_opening_hours_friday string
    • self_service_opening_hours_saturday string
    • self_service_opening_hours_sunday string
    • unified_cat_ids object

      Additional properties are allowed.

    • unified_cat_names object

      Additional properties are allowed.

GET /api/event/base_bookable_for_self_service_scope/{scope}
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/event/base_bookable_for_self_service_scope/{scope}' \
 --header "x-session-token: $API_KEY"
Response examples (200)
[
  {
    "baseLocation": {
      "id": 42,
      "token": "string",
      "location_type": "string",
      "created": "2025-05-04T09:42:00Z",
      "updated": "2025-05-04T09:42:00Z",
      "address": "string",
      "address_street": "string",
      "address_house_number": "string",
      "address_street_level": "string",
      "address_co": "string",
      "address_city": "string",
      "address_zip": "string",
      "address_admin_level1": "string",
      "address_country": "string",
      "address_full_country": "string",
      "address_geo_lat": "string",
      "address_geo_lng": "string",
      "address_external_provider_id": "string",
      "main_phone": "string",
      "main_fax": "string",
      "main_email": "string",
      "website": "string",
      "name": "string",
      "deleted": true,
      "short_identifier": "string",
      "image_url": "string",
      "slug_identifier": "string",
      "opening_hours_monday": "string",
      "opening_hours_tuesday": "string",
      "opening_hours_wednesday": "string",
      "opening_hours_thursday": "string",
      "opening_hours_friday": "string",
      "opening_hours_saturday": "string",
      "opening_hours_sunday": "string",
      "is_ui_filter": true,
      "unified_cat_ids": {},
      "unified_cat_names": {}
    },
    "id": 42,
    "token": "string",
    "bookable_type": "string",
    "floor_level": "string",
    "floor_size": 42,
    "pets_allowed": true,
    "barrier_free": true,
    "cargo_volume": 42,
    "fuel_type": "string",
    "seating_capacity": 42,
    "has_wait_list": true,
    "booking_limit": 42,
    "new_booking_only_in_blocks": true,
    "new_booking_only_in_opening_hours": true,
    "new_booking_only_in_self_service_opening_hours": true,
    "new_booking_limit_days_before": 42,
    "new_booking_limit_stop_days_before": 42,
    "delete_booking_hours_before": 42,
    "block_length": 42,
    "new_booking_min_length": 42,
    "new_booking_max_length": 42,
    "require_address": true,
    "require_contact": true,
    "require_billing": true,
    "require_booking_title": true,
    "allow_direct_billing": true,
    "require_age": true,
    "age_group": "string",
    "min_age": 42,
    "max_age": 42,
    "age_tolerance": 42,
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z",
    "address": "string",
    "address_street": "string",
    "address_house_number": "string",
    "address_street_level": "string",
    "address_co": "string",
    "address_city": "string",
    "address_zip": "string",
    "address_admin_level1": "string",
    "address_country": "string",
    "address_full_country": "string",
    "address_geo_lat": "string",
    "address_geo_lng": "string",
    "address_external_provider_id": "string",
    "main_phone": "string",
    "main_fax": "string",
    "main_email": "string",
    "website": "string",
    "name": "string",
    "deleted": true,
    "short_identifier": "string",
    "image_url": "string",
    "slug_identifier": "string",
    "opening_hours_monday": "string",
    "opening_hours_tuesday": "string",
    "opening_hours_wednesday": "string",
    "opening_hours_thursday": "string",
    "opening_hours_friday": "string",
    "opening_hours_saturday": "string",
    "opening_hours_sunday": "string",
    "self_service_opening_hours_monday": "string",
    "self_service_opening_hours_tuesday": "string",
    "self_service_opening_hours_wednesday": "string",
    "self_service_opening_hours_thursday": "string",
    "self_service_opening_hours_friday": "string",
    "self_service_opening_hours_saturday": "string",
    "self_service_opening_hours_sunday": "string",
    "unified_cat_ids": {},
    "unified_cat_names": {}
  }
]