BaseBookable

Locations and bookings7 EndpointsEvent / BaseBookable

Returns a list of BaseBookable objects

GET/api/event/base_bookable

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
`deleted`boolean	This property is used to mark an entity as deleted / archived
`billingMode`string	How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
`usageBillingInterval`string	Billing interval for BILLING_MODE_USAGE: USAGE_BILLING_INTERVAL_PER_BOOKING or USAGE_BILLING_INTERVAL_MONTHLY. Null = use setting event_real_usage_billing_mode.
`maxActiveBookingsPerUser`string	Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
`maxAdvanceBookingHours`string	Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
`inventoryManaged`boolean	Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
`inventoryNumber`string	Inventory number of the item (Inventarnummer).
`created`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of BaseBookable objectsarray<BaseBookable>

Show fields (79)

ticketSeatingPlanIdinteger
Id of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation4
Show fields (38)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- opening_hours_mondaystring
  Opening hours on Monday.
- opening_hours_tuesdaystring
  Opening hours on Tuesday.
- opening_hours_wednesdaystring
  Opening hours on Wednesday.
- opening_hours_thursdaystring
  Opening hours on Thursday.
- opening_hours_fridaystring
  Opening hours on Friday.
- opening_hours_saturdaystring
  Opening hours on Saturday.
- opening_hours_sundaystring
  Opening hours on Sunday.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the bookable. Internal ID.
tokenstring
Public token of the bookable. Used in links instead of the ID.
bookable_typestring
Type of the bookable, for example room, court or vehicle.
floor_levelstring
Floor the bookable is on.
floor_sizeinteger
Floor size in square meters.
pets_allowedboolean
Pets are allowed.
barrier_freeboolean
The bookable is barrier-free.
cargo_volumeinteger
Cargo volume in liters.
fuel_typestring
Fuel type of the vehicle.
seating_capacityinteger
Number of seats.
has_wait_listboolean
The bookable has a waiting list once it is fully booked.
booking_limitinteger
Maximum number of bookings.
billing_modestring
How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
max_active_bookings_per_userinteger
Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
max_advance_booking_hoursinteger
Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedboolean
Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
inventory_depositnumber (float)
Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
new_booking_only_in_blocksboolean
New bookings are only possible in the defined blocks.
new_booking_only_in_opening_hoursboolean
New bookings are only possible during the opening hours.
new_booking_only_in_self_service_opening_hoursboolean
New bookings are only possible during the self-service opening hours.
new_booking_limit_days_beforeinteger
Number of days before the start until which new bookings are possible.
new_booking_limit_stop_days_beforeinteger
Number of days before the start from which new bookings are closed.
delete_booking_hours_beforeinteger
Hours before the start until which a booking can be cancelled.
block_lengthinteger
Length of a booking block in minutes.
new_booking_min_lengthinteger
Minimum length of a new booking in minutes.
new_booking_max_lengthinteger
Maximum length of a new booking in minutes.
require_addressboolean
The address must be entered when booking.
require_contactboolean
Contact details must be entered when booking.
require_billingboolean
Billing details must be entered when booking.
require_booking_titleboolean
A title must be entered when booking.
allow_direct_billingboolean
require_ageboolean
The age must be entered when booking.
age_groupstring
Age group the bookable is intended for.
min_ageinteger
Minimum age in years.
max_ageinteger
Maximum age in years.
age_toleranceinteger
Years by which the age may be outside the range and still be accepted.
counter_update_modestring
How the usage counters of the bookable are updated.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.
namestring
Name of the entity.
deletedboolean
This property is used to mark an entity as deleted / archived
short_identifierstring
Short identifier of the entity.
image_urlstring
URL of the image of the entity.
slug_identifierstring
Slug used in URLs of the entity.
opening_hours_mondaystring
Opening hours on Monday.
opening_hours_tuesdaystring
Opening hours on Tuesday.
opening_hours_wednesdaystring
Opening hours on Wednesday.
opening_hours_thursdaystring
Opening hours on Thursday.
opening_hours_fridaystring
Opening hours on Friday.
opening_hours_saturdaystring
Opening hours on Saturday.
opening_hours_sundaystring
Opening hours on Sunday.
self_service_opening_hours_mondaystring
Self-service opening hours on Monday.
self_service_opening_hours_tuesdaystring
Self-service opening hours on Tuesday.
self_service_opening_hours_wednesdaystring
Self-service opening hours on Wednesday.
self_service_opening_hours_thursdaystring
Self-service opening hours on Thursday.
self_service_opening_hours_fridaystring
Self-service opening hours on Friday.
self_service_opening_hours_saturdaystring
Self-service opening hours on Saturday.
self_service_opening_hours_sundaystring
Self-service opening hours on Sunday.
unified_cat_idsobject
IDs of the unified categories.
unified_cat_namesobject
Names of the unified categories.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_bookable \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/event/base_bookable', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/event/base_bookable"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/base_bookable', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_bookable"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/event/base_bookable")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/event/base_bookable"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/event_base_bookable_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseBookableController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "require_booking_title": true,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Add a new BaseBookable

POST/api/event/base_bookable

Request body application/json

dataBaseBookable17
Show fields (21)
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Add a new BaseBookableBaseBookable

Show fields (79)

ticketSeatingPlanIdinteger
Id of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation4
Show fields (38)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- opening_hours_mondaystring
  Opening hours on Monday.
- opening_hours_tuesdaystring
  Opening hours on Tuesday.
- opening_hours_wednesdaystring
  Opening hours on Wednesday.
- opening_hours_thursdaystring
  Opening hours on Thursday.
- opening_hours_fridaystring
  Opening hours on Friday.
- opening_hours_saturdaystring
  Opening hours on Saturday.
- opening_hours_sundaystring
  Opening hours on Sunday.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the bookable. Internal ID.
tokenstring
Public token of the bookable. Used in links instead of the ID.
bookable_typestring
Type of the bookable, for example room, court or vehicle.
floor_levelstring
Floor the bookable is on.
floor_sizeinteger
Floor size in square meters.
pets_allowedboolean
Pets are allowed.
barrier_freeboolean
The bookable is barrier-free.
cargo_volumeinteger
Cargo volume in liters.
fuel_typestring
Fuel type of the vehicle.
seating_capacityinteger
Number of seats.
has_wait_listboolean
The bookable has a waiting list once it is fully booked.
booking_limitinteger
Maximum number of bookings.
billing_modestring
How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
max_active_bookings_per_userinteger
Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
max_advance_booking_hoursinteger
Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedboolean
Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
inventory_depositnumber (float)
Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
new_booking_only_in_blocksboolean
New bookings are only possible in the defined blocks.
new_booking_only_in_opening_hoursboolean
New bookings are only possible during the opening hours.
new_booking_only_in_self_service_opening_hoursboolean
New bookings are only possible during the self-service opening hours.
new_booking_limit_days_beforeinteger
Number of days before the start until which new bookings are possible.
new_booking_limit_stop_days_beforeinteger
Number of days before the start from which new bookings are closed.
delete_booking_hours_beforeinteger
Hours before the start until which a booking can be cancelled.
block_lengthinteger
Length of a booking block in minutes.
new_booking_min_lengthinteger
Minimum length of a new booking in minutes.
new_booking_max_lengthinteger
Maximum length of a new booking in minutes.
require_addressboolean
The address must be entered when booking.
require_contactboolean
Contact details must be entered when booking.
require_billingboolean
Billing details must be entered when booking.
require_booking_titleboolean
A title must be entered when booking.
allow_direct_billingboolean
require_ageboolean
The age must be entered when booking.
age_groupstring
Age group the bookable is intended for.
min_ageinteger
Minimum age in years.
max_ageinteger
Maximum age in years.
age_toleranceinteger
Years by which the age may be outside the range and still be accepted.
counter_update_modestring
How the usage counters of the bookable are updated.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.
namestring
Name of the entity.
deletedboolean
This property is used to mark an entity as deleted / archived
short_identifierstring
Short identifier of the entity.
image_urlstring
URL of the image of the entity.
slug_identifierstring
Slug used in URLs of the entity.
opening_hours_mondaystring
Opening hours on Monday.
opening_hours_tuesdaystring
Opening hours on Tuesday.
opening_hours_wednesdaystring
Opening hours on Wednesday.
opening_hours_thursdaystring
Opening hours on Thursday.
opening_hours_fridaystring
Opening hours on Friday.
opening_hours_saturdaystring
Opening hours on Saturday.
opening_hours_sundaystring
Opening hours on Sunday.
self_service_opening_hours_mondaystring
Self-service opening hours on Monday.
self_service_opening_hours_tuesdaystring
Self-service opening hours on Tuesday.
self_service_opening_hours_wednesdaystring
Self-service opening hours on Wednesday.
self_service_opening_hours_thursdaystring
Self-service opening hours on Thursday.
self_service_opening_hours_fridaystring
Self-service opening hours on Friday.
self_service_opening_hours_saturdaystring
Self-service opening hours on Saturday.
self_service_opening_hours_sundaystring
Self-service opening hours on Sunday.
unified_cat_idsobject
IDs of the unified categories.
unified_cat_namesobject
Names of the unified categories.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_bookable \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE',
      address_full_country: 'DE',
      main_phone: '+49 511 123456'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/event/base_bookable', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/event/base_bookable"

payload = { "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/event/base_bookable', [
  'body' => '{"data":{"address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE","address_full_country":"DE","main_phone":"+49 511 123456"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_bookable"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/event/base_bookable")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/event/base_bookable"

	payload := strings.NewReader("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/event_base_bookable_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_bookable.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseBookableController.post(EventBaseBookable.fromJson({
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "require_booking_title": true,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Returns a single BaseBookable

GET/api/event/base_bookable/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single BaseBookableBaseBookable

Show fields (79)

ticketSeatingPlanIdinteger
Id of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation4
Show fields (38)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- opening_hours_mondaystring
  Opening hours on Monday.
- opening_hours_tuesdaystring
  Opening hours on Tuesday.
- opening_hours_wednesdaystring
  Opening hours on Wednesday.
- opening_hours_thursdaystring
  Opening hours on Thursday.
- opening_hours_fridaystring
  Opening hours on Friday.
- opening_hours_saturdaystring
  Opening hours on Saturday.
- opening_hours_sundaystring
  Opening hours on Sunday.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the bookable. Internal ID.
tokenstring
Public token of the bookable. Used in links instead of the ID.
bookable_typestring
Type of the bookable, for example room, court or vehicle.
floor_levelstring
Floor the bookable is on.
floor_sizeinteger
Floor size in square meters.
pets_allowedboolean
Pets are allowed.
barrier_freeboolean
The bookable is barrier-free.
cargo_volumeinteger
Cargo volume in liters.
fuel_typestring
Fuel type of the vehicle.
seating_capacityinteger
Number of seats.
has_wait_listboolean
The bookable has a waiting list once it is fully booked.
booking_limitinteger
Maximum number of bookings.
billing_modestring
How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
max_active_bookings_per_userinteger
Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
max_advance_booking_hoursinteger
Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedboolean
Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
inventory_depositnumber (float)
Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
new_booking_only_in_blocksboolean
New bookings are only possible in the defined blocks.
new_booking_only_in_opening_hoursboolean
New bookings are only possible during the opening hours.
new_booking_only_in_self_service_opening_hoursboolean
New bookings are only possible during the self-service opening hours.
new_booking_limit_days_beforeinteger
Number of days before the start until which new bookings are possible.
new_booking_limit_stop_days_beforeinteger
Number of days before the start from which new bookings are closed.
delete_booking_hours_beforeinteger
Hours before the start until which a booking can be cancelled.
block_lengthinteger
Length of a booking block in minutes.
new_booking_min_lengthinteger
Minimum length of a new booking in minutes.
new_booking_max_lengthinteger
Maximum length of a new booking in minutes.
require_addressboolean
The address must be entered when booking.
require_contactboolean
Contact details must be entered when booking.
require_billingboolean
Billing details must be entered when booking.
require_booking_titleboolean
A title must be entered when booking.
allow_direct_billingboolean
require_ageboolean
The age must be entered when booking.
age_groupstring
Age group the bookable is intended for.
min_ageinteger
Minimum age in years.
max_ageinteger
Maximum age in years.
age_toleranceinteger
Years by which the age may be outside the range and still be accepted.
counter_update_modestring
How the usage counters of the bookable are updated.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.
namestring
Name of the entity.
deletedboolean
This property is used to mark an entity as deleted / archived
short_identifierstring
Short identifier of the entity.
image_urlstring
URL of the image of the entity.
slug_identifierstring
Slug used in URLs of the entity.
opening_hours_mondaystring
Opening hours on Monday.
opening_hours_tuesdaystring
Opening hours on Tuesday.
opening_hours_wednesdaystring
Opening hours on Wednesday.
opening_hours_thursdaystring
Opening hours on Thursday.
opening_hours_fridaystring
Opening hours on Friday.
opening_hours_saturdaystring
Opening hours on Saturday.
opening_hours_sundaystring
Opening hours on Sunday.
self_service_opening_hours_mondaystring
Self-service opening hours on Monday.
self_service_opening_hours_tuesdaystring
Self-service opening hours on Tuesday.
self_service_opening_hours_wednesdaystring
Self-service opening hours on Wednesday.
self_service_opening_hours_thursdaystring
Self-service opening hours on Thursday.
self_service_opening_hours_fridaystring
Self-service opening hours on Friday.
self_service_opening_hours_saturdaystring
Self-service opening hours on Saturday.
self_service_opening_hours_sundaystring
Self-service opening hours on Sunday.
unified_cat_idsobject
IDs of the unified categories.
unified_cat_namesobject
Names of the unified categories.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_bookable/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/event/base_bookable/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/event/base_bookable/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/base_bookable/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_bookable/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/event/base_bookable/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/event/base_bookable/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/event_base_bookable_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseBookableController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "require_booking_title": true,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Update a BaseBookable

PUT/api/event/base_bookable/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataBaseBookable17
Show fields (21)
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Update a BaseBookableBaseBookable

Show fields (79)

ticketSeatingPlanIdinteger
Id of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation4
Show fields (38)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- opening_hours_mondaystring
  Opening hours on Monday.
- opening_hours_tuesdaystring
  Opening hours on Tuesday.
- opening_hours_wednesdaystring
  Opening hours on Wednesday.
- opening_hours_thursdaystring
  Opening hours on Thursday.
- opening_hours_fridaystring
  Opening hours on Friday.
- opening_hours_saturdaystring
  Opening hours on Saturday.
- opening_hours_sundaystring
  Opening hours on Sunday.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the bookable. Internal ID.
tokenstring
Public token of the bookable. Used in links instead of the ID.
bookable_typestring
Type of the bookable, for example room, court or vehicle.
floor_levelstring
Floor the bookable is on.
floor_sizeinteger
Floor size in square meters.
pets_allowedboolean
Pets are allowed.
barrier_freeboolean
The bookable is barrier-free.
cargo_volumeinteger
Cargo volume in liters.
fuel_typestring
Fuel type of the vehicle.
seating_capacityinteger
Number of seats.
has_wait_listboolean
The bookable has a waiting list once it is fully booked.
booking_limitinteger
Maximum number of bookings.
billing_modestring
How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
max_active_bookings_per_userinteger
Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
max_advance_booking_hoursinteger
Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedboolean
Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
inventory_depositnumber (float)
Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
new_booking_only_in_blocksboolean
New bookings are only possible in the defined blocks.
new_booking_only_in_opening_hoursboolean
New bookings are only possible during the opening hours.
new_booking_only_in_self_service_opening_hoursboolean
New bookings are only possible during the self-service opening hours.
new_booking_limit_days_beforeinteger
Number of days before the start until which new bookings are possible.
new_booking_limit_stop_days_beforeinteger
Number of days before the start from which new bookings are closed.
delete_booking_hours_beforeinteger
Hours before the start until which a booking can be cancelled.
block_lengthinteger
Length of a booking block in minutes.
new_booking_min_lengthinteger
Minimum length of a new booking in minutes.
new_booking_max_lengthinteger
Maximum length of a new booking in minutes.
require_addressboolean
The address must be entered when booking.
require_contactboolean
Contact details must be entered when booking.
require_billingboolean
Billing details must be entered when booking.
require_booking_titleboolean
A title must be entered when booking.
allow_direct_billingboolean
require_ageboolean
The age must be entered when booking.
age_groupstring
Age group the bookable is intended for.
min_ageinteger
Minimum age in years.
max_ageinteger
Maximum age in years.
age_toleranceinteger
Years by which the age may be outside the range and still be accepted.
counter_update_modestring
How the usage counters of the bookable are updated.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.
namestring
Name of the entity.
deletedboolean
This property is used to mark an entity as deleted / archived
short_identifierstring
Short identifier of the entity.
image_urlstring
URL of the image of the entity.
slug_identifierstring
Slug used in URLs of the entity.
opening_hours_mondaystring
Opening hours on Monday.
opening_hours_tuesdaystring
Opening hours on Tuesday.
opening_hours_wednesdaystring
Opening hours on Wednesday.
opening_hours_thursdaystring
Opening hours on Thursday.
opening_hours_fridaystring
Opening hours on Friday.
opening_hours_saturdaystring
Opening hours on Saturday.
opening_hours_sundaystring
Opening hours on Sunday.
self_service_opening_hours_mondaystring
Self-service opening hours on Monday.
self_service_opening_hours_tuesdaystring
Self-service opening hours on Tuesday.
self_service_opening_hours_wednesdaystring
Self-service opening hours on Wednesday.
self_service_opening_hours_thursdaystring
Self-service opening hours on Thursday.
self_service_opening_hours_fridaystring
Self-service opening hours on Friday.
self_service_opening_hours_saturdaystring
Self-service opening hours on Saturday.
self_service_opening_hours_sundaystring
Self-service opening hours on Sunday.
unified_cat_idsobject
IDs of the unified categories.
unified_cat_namesobject
Names of the unified categories.

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/event/base_bookable/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE',
      address_full_country: 'DE',
      main_phone: '+49 511 123456'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/event/base_bookable/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/event/base_bookable/42"

payload = { "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/event/base_bookable/42', [
  'body' => '{"data":{"address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE","address_full_country":"DE","main_phone":"+49 511 123456"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_bookable/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/event/base_bookable/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/event/base_bookable/42"

	payload := strings.NewReader("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/event_base_bookable_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_bookable.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseBookableController.put(EventBaseBookable.fromJson({
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "require_booking_title": true,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Update a BaseBookable

PATCH/api/event/base_bookable/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataBaseBookable17
Show fields (21)
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- ucatsarray<UnifiedCategory11>
  Unified categories of the entity.

Responses

200Update a BaseBookableBaseBookable

Show fields (79)

ticketSeatingPlanIdinteger
Id of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation4
Show fields (38)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- opening_hours_mondaystring
  Opening hours on Monday.
- opening_hours_tuesdaystring
  Opening hours on Tuesday.
- opening_hours_wednesdaystring
  Opening hours on Wednesday.
- opening_hours_thursdaystring
  Opening hours on Thursday.
- opening_hours_fridaystring
  Opening hours on Friday.
- opening_hours_saturdaystring
  Opening hours on Saturday.
- opening_hours_sundaystring
  Opening hours on Sunday.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the bookable. Internal ID.
tokenstring
Public token of the bookable. Used in links instead of the ID.
bookable_typestring
Type of the bookable, for example room, court or vehicle.
floor_levelstring
Floor the bookable is on.
floor_sizeinteger
Floor size in square meters.
pets_allowedboolean
Pets are allowed.
barrier_freeboolean
The bookable is barrier-free.
cargo_volumeinteger
Cargo volume in liters.
fuel_typestring
Fuel type of the vehicle.
seating_capacityinteger
Number of seats.
has_wait_listboolean
The bookable has a waiting list once it is fully booked.
booking_limitinteger
Maximum number of bookings.
billing_modestring
How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
max_active_bookings_per_userinteger
Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
max_advance_booking_hoursinteger
Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedboolean
Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
inventory_depositnumber (float)
Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
new_booking_only_in_blocksboolean
New bookings are only possible in the defined blocks.
new_booking_only_in_opening_hoursboolean
New bookings are only possible during the opening hours.
new_booking_only_in_self_service_opening_hoursboolean
New bookings are only possible during the self-service opening hours.
new_booking_limit_days_beforeinteger
Number of days before the start until which new bookings are possible.
new_booking_limit_stop_days_beforeinteger
Number of days before the start from which new bookings are closed.
delete_booking_hours_beforeinteger
Hours before the start until which a booking can be cancelled.
block_lengthinteger
Length of a booking block in minutes.
new_booking_min_lengthinteger
Minimum length of a new booking in minutes.
new_booking_max_lengthinteger
Maximum length of a new booking in minutes.
require_addressboolean
The address must be entered when booking.
require_contactboolean
Contact details must be entered when booking.
require_billingboolean
Billing details must be entered when booking.
require_booking_titleboolean
A title must be entered when booking.
allow_direct_billingboolean
require_ageboolean
The age must be entered when booking.
age_groupstring
Age group the bookable is intended for.
min_ageinteger
Minimum age in years.
max_ageinteger
Maximum age in years.
age_toleranceinteger
Years by which the age may be outside the range and still be accepted.
counter_update_modestring
How the usage counters of the bookable are updated.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.
namestring
Name of the entity.
deletedboolean
This property is used to mark an entity as deleted / archived
short_identifierstring
Short identifier of the entity.
image_urlstring
URL of the image of the entity.
slug_identifierstring
Slug used in URLs of the entity.
opening_hours_mondaystring
Opening hours on Monday.
opening_hours_tuesdaystring
Opening hours on Tuesday.
opening_hours_wednesdaystring
Opening hours on Wednesday.
opening_hours_thursdaystring
Opening hours on Thursday.
opening_hours_fridaystring
Opening hours on Friday.
opening_hours_saturdaystring
Opening hours on Saturday.
opening_hours_sundaystring
Opening hours on Sunday.
self_service_opening_hours_mondaystring
Self-service opening hours on Monday.
self_service_opening_hours_tuesdaystring
Self-service opening hours on Tuesday.
self_service_opening_hours_wednesdaystring
Self-service opening hours on Wednesday.
self_service_opening_hours_thursdaystring
Self-service opening hours on Thursday.
self_service_opening_hours_fridaystring
Self-service opening hours on Friday.
self_service_opening_hours_saturdaystring
Self-service opening hours on Saturday.
self_service_opening_hours_sundaystring
Self-service opening hours on Sunday.
unified_cat_idsobject
IDs of the unified categories.
unified_cat_namesobject
Names of the unified categories.

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/event/base_bookable/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      address_street: 'Jakobistr. 39',
      address_city: 'Hannover',
      address_zip: '30163',
      address_country: 'DE',
      address_full_country: 'DE',
      main_phone: '+49 511 123456'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/event/base_bookable/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/event/base_bookable/42"

payload = { "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/event/base_bookable/42', [
  'body' => '{"data":{"address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE","address_full_country":"DE","main_phone":"+49 511 123456"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_bookable/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/event/base_bookable/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/event/base_bookable/42"

	payload := strings.NewReader("{\"data\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"main_phone\":\"+49 511 123456\"}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/event/base_bookable/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456"
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "require_booking_title": true,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

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

GET/api/event/base_bookable_for_self_service_scope/{scope}

Path parameters

scoperequiredstring

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
`deleted`boolean	This property is used to mark an entity as deleted / archived
`billingMode`string	How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
`usageBillingInterval`string	Billing interval for BILLING_MODE_USAGE: USAGE_BILLING_INTERVAL_PER_BOOKING or USAGE_BILLING_INTERVAL_MONTHLY. Null = use setting event_real_usage_billing_mode.
`maxActiveBookingsPerUser`string	Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
`maxAdvanceBookingHours`string	Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
`inventoryManaged`boolean	Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
`inventoryNumber`string	Inventory number of the item (Inventarnummer).
`created`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of BaseBookable objects with given self-service access scopearray<BaseBookable>

Show fields (79)

ticketSeatingPlanIdinteger
Id of the seating plan of the room, also for the public serialization.
baseLocationBaseLocation4
Show fields (38)
- idinteger
  Primary key of the location. Internal ID.
- tokenstring
  Public token of the location. Used in links instead of the ID.
- location_typestring
  Type of the location, for example room, hall or outdoor area.
- in_contact_centerboolean
  The location is shown in the contact center.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- short_identifierstring
  Short identifier of the entity.
- image_urlstring
  URL of the image of the entity.
- slug_identifierstring
  Slug used in URLs of the entity.
- opening_hours_mondaystring
  Opening hours on Monday.
- opening_hours_tuesdaystring
  Opening hours on Tuesday.
- opening_hours_wednesdaystring
  Opening hours on Wednesday.
- opening_hours_thursdaystring
  Opening hours on Thursday.
- opening_hours_fridaystring
  Opening hours on Friday.
- opening_hours_saturdaystring
  Opening hours on Saturday.
- opening_hours_sundaystring
  Opening hours on Sunday.
- is_ui_filterboolean
  This property is used to mark an entity as a filter for the frontend
- unified_cat_idsobject
  IDs of the unified categories.
- unified_cat_namesobject
  Names of the unified categories.
idinteger
Primary key of the bookable. Internal ID.
tokenstring
Public token of the bookable. Used in links instead of the ID.
bookable_typestring
Type of the bookable, for example room, court or vehicle.
floor_levelstring
Floor the bookable is on.
floor_sizeinteger
Floor size in square meters.
pets_allowedboolean
Pets are allowed.
barrier_freeboolean
The bookable is barrier-free.
cargo_volumeinteger
Cargo volume in liters.
fuel_typestring
Fuel type of the vehicle.
seating_capacityinteger
Number of seats.
has_wait_listboolean
The bookable has a waiting list once it is fully booked.
booking_limitinteger
Maximum number of bookings.
billing_modestring
How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.
max_active_bookings_per_userinteger
Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.
max_advance_booking_hoursinteger
Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.
inventory_managedboolean
Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.
inventory_depositnumber (float)
Deposit (Kaution) per piece asked on hand-over. Null = no deposit.
new_booking_only_in_blocksboolean
New bookings are only possible in the defined blocks.
new_booking_only_in_opening_hoursboolean
New bookings are only possible during the opening hours.
new_booking_only_in_self_service_opening_hoursboolean
New bookings are only possible during the self-service opening hours.
new_booking_limit_days_beforeinteger
Number of days before the start until which new bookings are possible.
new_booking_limit_stop_days_beforeinteger
Number of days before the start from which new bookings are closed.
delete_booking_hours_beforeinteger
Hours before the start until which a booking can be cancelled.
block_lengthinteger
Length of a booking block in minutes.
new_booking_min_lengthinteger
Minimum length of a new booking in minutes.
new_booking_max_lengthinteger
Maximum length of a new booking in minutes.
require_addressboolean
The address must be entered when booking.
require_contactboolean
Contact details must be entered when booking.
require_billingboolean
Billing details must be entered when booking.
require_booking_titleboolean
A title must be entered when booking.
allow_direct_billingboolean
require_ageboolean
The age must be entered when booking.
age_groupstring
Age group the bookable is intended for.
min_ageinteger
Minimum age in years.
max_ageinteger
Maximum age in years.
age_toleranceinteger
Years by which the age may be outside the range and still be accepted.
counter_update_modestring
How the usage counters of the bookable are updated.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.
namestring
Name of the entity.
deletedboolean
This property is used to mark an entity as deleted / archived
short_identifierstring
Short identifier of the entity.
image_urlstring
URL of the image of the entity.
slug_identifierstring
Slug used in URLs of the entity.
opening_hours_mondaystring
Opening hours on Monday.
opening_hours_tuesdaystring
Opening hours on Tuesday.
opening_hours_wednesdaystring
Opening hours on Wednesday.
opening_hours_thursdaystring
Opening hours on Thursday.
opening_hours_fridaystring
Opening hours on Friday.
opening_hours_saturdaystring
Opening hours on Saturday.
opening_hours_sundaystring
Opening hours on Sunday.
self_service_opening_hours_mondaystring
Self-service opening hours on Monday.
self_service_opening_hours_tuesdaystring
Self-service opening hours on Tuesday.
self_service_opening_hours_wednesdaystring
Self-service opening hours on Wednesday.
self_service_opening_hours_thursdaystring
Self-service opening hours on Thursday.
self_service_opening_hours_fridaystring
Self-service opening hours on Friday.
self_service_opening_hours_saturdaystring
Self-service opening hours on Saturday.
self_service_opening_hours_sundaystring
Self-service opening hours on Sunday.
unified_cat_idsobject
IDs of the unified categories.
unified_cat_namesobject
Names of the unified categories.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_bookable_for_self_service_scope/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/event/base_bookable_for_self_service_scope/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/event/base_bookable_for_self_service_scope/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/base_bookable_for_self_service_scope/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_bookable_for_self_service_scope/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/event/base_bookable_for_self_service_scope/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/event/base_bookable_for_self_service_scope/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/event_base_bookable_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseBookableController.getAllForSelfServiceScope('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "require_booking_title": true,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Returns a calendar feed for a bookable

GET/api/event/base_bookable_calendar/{identifier}/{anonymized}

Path parameters

`identifier`requiredstring
`anonymized`requiredstring

Responses

default

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_bookable_calendar/42/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/event/base_bookable_calendar/42/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/event/base_bookable_calendar/42/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/event/base_bookable_calendar/42/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/event/base_bookable_calendar/42/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/event/base_bookable_calendar/42/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/event/base_bookable_calendar/42/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'package:http/http.dart' as http;

final response = await http.get(
  Uri.parse('https://your-instance.iw-erp.de/api/event/base_bookable_calendar/42/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);