Zum Inhalt springen
Developer

BaseLocation

Orte und Buchungen5 EndpunkteEvent / BaseLocation

Liefert eine Liste der BaseLocation-Einträge.

GET/api/event/base_location

Query-Parameter

namestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
tokenstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
locationTypestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
addressStreetLevelstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
addressCitystringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
addressZipstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
addressCountrystringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
addressGeoLatstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
addressGeoLngstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
isUiFilterstringDiese Eigenschaft markiert eine Entität als Filter für das Frontend | Benötigtes Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
inContactCenterstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, SCOPE
idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE
slugIdentifierstring
createdstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Gibt alle BaseLocation-Objekte zurück.array<BaseLocation>

Felder anzeigen (41)
  • idinteger

    Primärschlüssel des Standorts. Interne ID.

  • tokenstring

    Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

  • location_typestring

    Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

  • in_contact_centerboolean

    Der Standort wird im Kontaktcenter angezeigt.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser42

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • import_origin_idstring

    ID des Datensatzes im Quellsystem des Imports.

  • import_origin_id_altstring

    Alternative ID des Datensatzes im Quellsystem des Imports.

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • is_ui_filterboolean

    Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • ucatsarray<UnifiedCategory18>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (34)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory18>

      Untergeordnete Kategorien.

    • parentUnifiedCategory18

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • import_origin_idstring

      ID des Datensatzes im Quellsystem des Imports.

    • import_origin_id_altstring

      Alternative ID des Datensatzes im Quellsystem des Imports.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_location \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "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",
    "image_url": "https://vynst.de"
  }
]

BaseLocation neu anlegen

POST/api/event/base_location

Request-Body application/json

  • dataBaseLocation2
    Felder anzeigen (1)
    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

Antworten

200BaseLocation neu anlegenBaseLocation

Felder anzeigen (41)
  • idinteger

    Primärschlüssel des Standorts. Interne ID.

  • tokenstring

    Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

  • location_typestring

    Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

  • in_contact_centerboolean

    Der Standort wird im Kontaktcenter angezeigt.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser42

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • import_origin_idstring

    ID des Datensatzes im Quellsystem des Imports.

  • import_origin_id_altstring

    Alternative ID des Datensatzes im Quellsystem des Imports.

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • is_ui_filterboolean

    Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • ucatsarray<UnifiedCategory18>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (34)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory18>

      Untergeordnete Kategorien.

    • parentUnifiedCategory18

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • import_origin_idstring

      ID des Datensatzes im Quellsystem des Imports.

    • import_origin_id_altstring

      Alternative ID des Datensatzes im Quellsystem des Imports.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/base_location \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "in_contact_center": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "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",
  "image_url": "https://vynst.de"
}

Gibt ein einzelnes BaseLocation-Objekt zurück.

GET/api/event/base_location/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Gibt ein einzelnes BaseLocation-Objekt zurück.BaseLocation

Felder anzeigen (41)
  • idinteger

    Primärschlüssel des Standorts. Interne ID.

  • tokenstring

    Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

  • location_typestring

    Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

  • in_contact_centerboolean

    Der Standort wird im Kontaktcenter angezeigt.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser42

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • import_origin_idstring

    ID des Datensatzes im Quellsystem des Imports.

  • import_origin_id_altstring

    Alternative ID des Datensatzes im Quellsystem des Imports.

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • is_ui_filterboolean

    Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • ucatsarray<UnifiedCategory18>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (34)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory18>

      Untergeordnete Kategorien.

    • parentUnifiedCategory18

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • import_origin_idstring

      ID des Datensatzes im Quellsystem des Imports.

    • import_origin_id_altstring

      Alternative ID des Datensatzes im Quellsystem des Imports.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_location/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "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",
  "image_url": "https://vynst.de"
}

BaseLocation aktualisieren

PUT/api/event/base_location/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseLocation2
    Felder anzeigen (1)
    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

Antworten

200BaseLocation aktualisierenBaseLocation

Felder anzeigen (41)
  • idinteger

    Primärschlüssel des Standorts. Interne ID.

  • tokenstring

    Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

  • location_typestring

    Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

  • in_contact_centerboolean

    Der Standort wird im Kontaktcenter angezeigt.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser42

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • import_origin_idstring

    ID des Datensatzes im Quellsystem des Imports.

  • import_origin_id_altstring

    Alternative ID des Datensatzes im Quellsystem des Imports.

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • is_ui_filterboolean

    Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • ucatsarray<UnifiedCategory18>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (34)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory18>

      Untergeordnete Kategorien.

    • parentUnifiedCategory18

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • import_origin_idstring

      ID des Datensatzes im Quellsystem des Imports.

    • import_origin_id_altstring

      Alternative ID des Datensatzes im Quellsystem des Imports.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/event/base_location/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "in_contact_center": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "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",
  "image_url": "https://vynst.de"
}

BaseLocation aktualisieren

PATCH/api/event/base_location/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseLocation2
    Felder anzeigen (1)
    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

Antworten

200BaseLocation aktualisierenBaseLocation

Felder anzeigen (41)
  • idinteger

    Primärschlüssel des Standorts. Interne ID.

  • tokenstring

    Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

  • location_typestring

    Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

  • in_contact_centerboolean

    Der Standort wird im Kontaktcenter angezeigt.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • visibility_typestring

    Art der Sichtbarkeit des Datensatzes.

  • arslistarray<AccessRightStorage>

    Zugriffsrechteliste, die die Sichtbarkeit steuert.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel des Zugriffsrechte-Eintrags. Interne ID.

    • userUser42

      Benutzer, der die Berechtigung erhält. Nur gesetzt bei benutzerbezogenen Rechten.

    • access_tagAccessTag

      Zugriffs-Tag, für das die Berechtigung gilt. Nur gesetzt bei Rechten auf ein Tag.

    • create_mainboolean

      Anlegen-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • edit_mainboolean

      Bearbeiten-Berechtigung für Hauptdatensätze des Zugriffs-Tags.

    • read_mainboolean

      Leseberechtigung für Hauptdatensätze des Zugriffs-Tags.

    • create_childboolean

      Anlegen-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • edit_childboolean

      Bearbeiten-Berechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • read_childboolean

      Leseberechtigung für untergeordnete Datensätze (zum Beispiel Positionen innerhalb eines Hauptdatensatzes).

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • import_origin_idstring

    ID des Datensatzes im Quellsystem des Imports.

  • import_origin_id_altstring

    Alternative ID des Datensatzes im Quellsystem des Imports.

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • is_ui_filterboolean

    Diese Eigenschaft markiert eine Entität als Filter für das Frontend

  • ucatsarray<UnifiedCategory18>

    Vereinheitlichte Kategorien des Datensatzes.

    Felder anzeigen (34)
    • idinteger

      Primärschlüssel der einheitlichen Kategorie. Interne ID.

    • category_typestring

      Art der Kategorie, zum Beispiel Kurs oder Mitgliedschaft.

    • childrenarray<UnifiedCategory18>

      Untergeordnete Kategorien.

    • parentUnifiedCategory18

      Übergeordnete Kategorie.

    • view_orderinteger

      Sortierreihenfolge der Kategorie in Listen.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

    • import_origin_idstring

      ID des Datensatzes im Quellsystem des Imports.

    • import_origin_id_altstring

      Alternative ID des Datensatzes im Quellsystem des Imports.

    • short_identifierstring

      Kurzkennung der Entität.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/event/base_location/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "in_contact_center": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "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",
  "image_url": "https://vynst.de"
}