Zum Inhalt springen
Developer

TrialPolicy (Schnupper-Regel)

Veranstaltungen6 EndpunkteEvent / TrialPolicy (Schnupper-Regel)

Liefert eine Liste der Probetermin-Richtlinien-Einträge.

GET/api/event/trial_policy

Query-Parameter

idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE | Standardwert: false
namestring
activeboolean
scopestring
audiencestring
capacityModestring
priceModestring
createdstring
updatedstring
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

200Liefert eine Liste der TrialPolicy-Objekte.array<TrialPolicy>

Felder anzeigen (28)
  • idinteger

    Primärschlüssel der Probezeit-Richtlinie. Interne ID.

  • activeboolean

    Die Probezeit-Regelung ist aktiv.

  • max_sessionsinteger

    Anzahl der Probetermine je Durchgang

  • scopestring

    Geltungsbereich der Probe-Regel, zum Beispiel je Veranstaltung oder je Buchbarem.

  • validity_daysinteger

    Tage ab dem ersten Probetermin, in denen der Pass genutzt werden darf; null = kein Limit

  • price_modestring

    Wie der Preis eines Schnuppertermins berechnet wird, zum Beispiel kostenlos oder ermäßigt.

  • productPredefinedBillingItem12

    Produkt, das für eine kostenpflichtige Probe abgerechnet wird (pro Termin oder einmal für den Pass)

    Felder anzeigen (21)
    • idinteger

      Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.

    • namestringPflicht

      Name der Abrechnungsposition.

    • descriptionstringPflicht

      Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.

    • fixed_pricenumber (float)

      Fester abgerechneter Preis.

    • fixed_price_base_unitnumber (float)

      Basiseinheit für den Festpreis.

    • billing_typeBillingItemType

      Typ der Abrechnungsposition.

    • recurrenceCRMRecurrence

      Wiederholung, der die Abrechnungsposition folgt.

    • deletedboolean

      Ob die Abrechnungsposition gelöscht ist.

    • sub_self_service_addboolean

      Ob Mitglieder das Abonnement selbst hinzufügen können.

    • sub_self_service_add_fixed_pricenumber (float)

      Fester Preis, der berechnet wird, wenn Mitglieder das Abo selbst hinzufügen.

    • price_is_bruttoboolean

      Ob die Preise Bruttopreise inklusive Steuer sind.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • is_preferredboolean

      Der Posten ist bevorzugt und wird zuerst angezeigt.

    • is_defaultboolean

      Der Posten ist der Standard für seinen Typ.

    • is_discountboolean

      Der Posten ist ein Rabatt.

    • is_freeboolean

      Der Posten ist kostenfrei.

    • is_passiveboolean

      Der Posten ist passiv und kann nicht mehr ausgewählt werden.

    • is_globalboolean

      Der Posten ist für alle Unternehmen verfügbar.

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels.

  • audiencestring

    Zielgruppe, für die die Probe-Regel gilt, zum Beispiel neue Mitglieder.

  • capacity_modestring

    Wie die Kapazität für Schnuppertermine genutzt wird.

  • quota_per_dateinteger

    Schnupper-Anmeldungen pro Termin mit Kapazitätsmodus own_quota

  • hide_when_fullboolean

    Veranstaltungen ohne freien Platz für Personen mit Schnupper-Interesse ausblenden (sonst angezeigt, aber nicht buchbar)

  • count_modestring

    Wie Schnuppertermine gezählt werden, zum Beispiel pro Person oder pro Event.

  • max_open_sessionsinteger

    Zukünftige Schnuppertermine, die eine Person gleichzeitig halten darf

  • cancel_hoursinteger

    Stunden vor Beginn eines Termins, bis zu denen eine Stornierung den Schnuppertermin zurückgibt

  • check_ageboolean

    Prüft die Altersgrenzen der Veranstaltung (minAge / maxAge) anhand des Geburtstags der Person

  • follow_upstring

    Was nach einer Probezeit passiert, zum Beispiel ein Anmeldeangebot.

  • follow_up_delay_hoursinteger

    Stunden nach dem Ende des letzten Schnuppertermins, bevor die Nachbetreuung beginnt

  • reminder_daysinteger

    Tage nach der Follow-up-Mail für eine Erinnerung, solange die Person nicht konvertiert hat; null = keine

  • membership_urlstring

    Wohin „Mitglied werden“ führt; leer = Einstellung event_trial_membership_url

  • mail_completed_textstring

    Kurztext der E-Mail, die versendet wird, wenn eine Probe abgeschlossen wird.

  • mail_completed_long_textstring

    Langtext der E-Mail, die gesendet wird, wenn ein Probetraining abgeschlossen wird.

  • hold_modestring

    Einen Kursplatz für die Probeperson ab dem ersten Schnuppertermin reservieren (keine = keine Reservierung)

  • hold_daysinteger

    Tage nach dem Ende des letzten Probetermins, an dem der reservierte Platz für die Anmeldung frei bleibt

  • hold_reminder_daysinteger

    Tage vor dem Ende der Sperre für eine Erinnerung; null = keine

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

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/trial_policy \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "membership_url": "https://vynst.de",
    "mail_completed_text": "Text",
    "mail_completed_long_text": "Text",
    "name": "Beispiel",
    "active": true,
    "max_sessions": 1,
    "scope": "string",
    "validity_days": 1,
    "price_mode": "string"
  }
]

Legt einen neuen Eintrag für eine Schnupperregel an.

POST/api/event/trial_policy

Request-Body application/json

  • dataTrialPolicy2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200TrialPolicy neu anlegenTrialPolicy

Felder anzeigen (28)
  • idinteger

    Primärschlüssel der Probezeit-Richtlinie. Interne ID.

  • activeboolean

    Die Probezeit-Regelung ist aktiv.

  • max_sessionsinteger

    Anzahl der Probetermine je Durchgang

  • scopestring

    Geltungsbereich der Probe-Regel, zum Beispiel je Veranstaltung oder je Buchbarem.

  • validity_daysinteger

    Tage ab dem ersten Probetermin, in denen der Pass genutzt werden darf; null = kein Limit

  • price_modestring

    Wie der Preis eines Schnuppertermins berechnet wird, zum Beispiel kostenlos oder ermäßigt.

  • productPredefinedBillingItem12

    Produkt, das für eine kostenpflichtige Probe abgerechnet wird (pro Termin oder einmal für den Pass)

    Felder anzeigen (21)
    • idinteger

      Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.

    • namestringPflicht

      Name der Abrechnungsposition.

    • descriptionstringPflicht

      Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.

    • fixed_pricenumber (float)

      Fester abgerechneter Preis.

    • fixed_price_base_unitnumber (float)

      Basiseinheit für den Festpreis.

    • billing_typeBillingItemType

      Typ der Abrechnungsposition.

    • recurrenceCRMRecurrence

      Wiederholung, der die Abrechnungsposition folgt.

    • deletedboolean

      Ob die Abrechnungsposition gelöscht ist.

    • sub_self_service_addboolean

      Ob Mitglieder das Abonnement selbst hinzufügen können.

    • sub_self_service_add_fixed_pricenumber (float)

      Fester Preis, der berechnet wird, wenn Mitglieder das Abo selbst hinzufügen.

    • price_is_bruttoboolean

      Ob die Preise Bruttopreise inklusive Steuer sind.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • is_preferredboolean

      Der Posten ist bevorzugt und wird zuerst angezeigt.

    • is_defaultboolean

      Der Posten ist der Standard für seinen Typ.

    • is_discountboolean

      Der Posten ist ein Rabatt.

    • is_freeboolean

      Der Posten ist kostenfrei.

    • is_passiveboolean

      Der Posten ist passiv und kann nicht mehr ausgewählt werden.

    • is_globalboolean

      Der Posten ist für alle Unternehmen verfügbar.

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels.

  • audiencestring

    Zielgruppe, für die die Probe-Regel gilt, zum Beispiel neue Mitglieder.

  • capacity_modestring

    Wie die Kapazität für Schnuppertermine genutzt wird.

  • quota_per_dateinteger

    Schnupper-Anmeldungen pro Termin mit Kapazitätsmodus own_quota

  • hide_when_fullboolean

    Veranstaltungen ohne freien Platz für Personen mit Schnupper-Interesse ausblenden (sonst angezeigt, aber nicht buchbar)

  • count_modestring

    Wie Schnuppertermine gezählt werden, zum Beispiel pro Person oder pro Event.

  • max_open_sessionsinteger

    Zukünftige Schnuppertermine, die eine Person gleichzeitig halten darf

  • cancel_hoursinteger

    Stunden vor Beginn eines Termins, bis zu denen eine Stornierung den Schnuppertermin zurückgibt

  • check_ageboolean

    Prüft die Altersgrenzen der Veranstaltung (minAge / maxAge) anhand des Geburtstags der Person

  • follow_upstring

    Was nach einer Probezeit passiert, zum Beispiel ein Anmeldeangebot.

  • follow_up_delay_hoursinteger

    Stunden nach dem Ende des letzten Schnuppertermins, bevor die Nachbetreuung beginnt

  • reminder_daysinteger

    Tage nach der Follow-up-Mail für eine Erinnerung, solange die Person nicht konvertiert hat; null = keine

  • membership_urlstring

    Wohin „Mitglied werden“ führt; leer = Einstellung event_trial_membership_url

  • mail_completed_textstring

    Kurztext der E-Mail, die versendet wird, wenn eine Probe abgeschlossen wird.

  • mail_completed_long_textstring

    Langtext der E-Mail, die gesendet wird, wenn ein Probetraining abgeschlossen wird.

  • hold_modestring

    Einen Kursplatz für die Probeperson ab dem ersten Schnuppertermin reservieren (keine = keine Reservierung)

  • hold_daysinteger

    Tage nach dem Ende des letzten Probetermins, an dem der reservierte Platz für die Anmeldung frei bleibt

  • hold_reminder_daysinteger

    Tage vor dem Ende der Sperre für eine Erinnerung; null = keine

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

  • deletedboolean

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

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/trial_policy \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "membership_url": "https://vynst.de",
  "mail_completed_text": "Text",
  "mail_completed_long_text": "Text",
  "name": "Beispiel",
  "active": true,
  "max_sessions": 1,
  "scope": "string",
  "validity_days": 1,
  "price_mode": "string"
}

Liefert einen einzelnen Probetermin-Richtlinien-Eintrag.

GET/api/event/trial_policy/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes TrialPolicy-Objekt.TrialPolicy

Felder anzeigen (28)
  • idinteger

    Primärschlüssel der Probezeit-Richtlinie. Interne ID.

  • activeboolean

    Die Probezeit-Regelung ist aktiv.

  • max_sessionsinteger

    Anzahl der Probetermine je Durchgang

  • scopestring

    Geltungsbereich der Probe-Regel, zum Beispiel je Veranstaltung oder je Buchbarem.

  • validity_daysinteger

    Tage ab dem ersten Probetermin, in denen der Pass genutzt werden darf; null = kein Limit

  • price_modestring

    Wie der Preis eines Schnuppertermins berechnet wird, zum Beispiel kostenlos oder ermäßigt.

  • productPredefinedBillingItem12

    Produkt, das für eine kostenpflichtige Probe abgerechnet wird (pro Termin oder einmal für den Pass)

    Felder anzeigen (21)
    • idinteger

      Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.

    • namestringPflicht

      Name der Abrechnungsposition.

    • descriptionstringPflicht

      Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.

    • fixed_pricenumber (float)

      Fester abgerechneter Preis.

    • fixed_price_base_unitnumber (float)

      Basiseinheit für den Festpreis.

    • billing_typeBillingItemType

      Typ der Abrechnungsposition.

    • recurrenceCRMRecurrence

      Wiederholung, der die Abrechnungsposition folgt.

    • deletedboolean

      Ob die Abrechnungsposition gelöscht ist.

    • sub_self_service_addboolean

      Ob Mitglieder das Abonnement selbst hinzufügen können.

    • sub_self_service_add_fixed_pricenumber (float)

      Fester Preis, der berechnet wird, wenn Mitglieder das Abo selbst hinzufügen.

    • price_is_bruttoboolean

      Ob die Preise Bruttopreise inklusive Steuer sind.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • is_preferredboolean

      Der Posten ist bevorzugt und wird zuerst angezeigt.

    • is_defaultboolean

      Der Posten ist der Standard für seinen Typ.

    • is_discountboolean

      Der Posten ist ein Rabatt.

    • is_freeboolean

      Der Posten ist kostenfrei.

    • is_passiveboolean

      Der Posten ist passiv und kann nicht mehr ausgewählt werden.

    • is_globalboolean

      Der Posten ist für alle Unternehmen verfügbar.

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels.

  • audiencestring

    Zielgruppe, für die die Probe-Regel gilt, zum Beispiel neue Mitglieder.

  • capacity_modestring

    Wie die Kapazität für Schnuppertermine genutzt wird.

  • quota_per_dateinteger

    Schnupper-Anmeldungen pro Termin mit Kapazitätsmodus own_quota

  • hide_when_fullboolean

    Veranstaltungen ohne freien Platz für Personen mit Schnupper-Interesse ausblenden (sonst angezeigt, aber nicht buchbar)

  • count_modestring

    Wie Schnuppertermine gezählt werden, zum Beispiel pro Person oder pro Event.

  • max_open_sessionsinteger

    Zukünftige Schnuppertermine, die eine Person gleichzeitig halten darf

  • cancel_hoursinteger

    Stunden vor Beginn eines Termins, bis zu denen eine Stornierung den Schnuppertermin zurückgibt

  • check_ageboolean

    Prüft die Altersgrenzen der Veranstaltung (minAge / maxAge) anhand des Geburtstags der Person

  • follow_upstring

    Was nach einer Probezeit passiert, zum Beispiel ein Anmeldeangebot.

  • follow_up_delay_hoursinteger

    Stunden nach dem Ende des letzten Schnuppertermins, bevor die Nachbetreuung beginnt

  • reminder_daysinteger

    Tage nach der Follow-up-Mail für eine Erinnerung, solange die Person nicht konvertiert hat; null = keine

  • membership_urlstring

    Wohin „Mitglied werden“ führt; leer = Einstellung event_trial_membership_url

  • mail_completed_textstring

    Kurztext der E-Mail, die versendet wird, wenn eine Probe abgeschlossen wird.

  • mail_completed_long_textstring

    Langtext der E-Mail, die gesendet wird, wenn ein Probetraining abgeschlossen wird.

  • hold_modestring

    Einen Kursplatz für die Probeperson ab dem ersten Schnuppertermin reservieren (keine = keine Reservierung)

  • hold_daysinteger

    Tage nach dem Ende des letzten Probetermins, an dem der reservierte Platz für die Anmeldung frei bleibt

  • hold_reminder_daysinteger

    Tage vor dem Ende der Sperre für eine Erinnerung; null = keine

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

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/trial_policy/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "membership_url": "https://vynst.de",
  "mail_completed_text": "Text",
  "mail_completed_long_text": "Text",
  "name": "Beispiel",
  "active": true,
  "max_sessions": 1,
  "scope": "string",
  "validity_days": 1,
  "price_mode": "string"
}

Aktualisiert einen vorhandenen Eintrag der Probe-Richtlinie.

PUT/api/event/trial_policy/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataTrialPolicy2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200TrialPolicy aktualisierenTrialPolicy

Felder anzeigen (28)
  • idinteger

    Primärschlüssel der Probezeit-Richtlinie. Interne ID.

  • activeboolean

    Die Probezeit-Regelung ist aktiv.

  • max_sessionsinteger

    Anzahl der Probetermine je Durchgang

  • scopestring

    Geltungsbereich der Probe-Regel, zum Beispiel je Veranstaltung oder je Buchbarem.

  • validity_daysinteger

    Tage ab dem ersten Probetermin, in denen der Pass genutzt werden darf; null = kein Limit

  • price_modestring

    Wie der Preis eines Schnuppertermins berechnet wird, zum Beispiel kostenlos oder ermäßigt.

  • productPredefinedBillingItem12

    Produkt, das für eine kostenpflichtige Probe abgerechnet wird (pro Termin oder einmal für den Pass)

    Felder anzeigen (21)
    • idinteger

      Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.

    • namestringPflicht

      Name der Abrechnungsposition.

    • descriptionstringPflicht

      Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.

    • fixed_pricenumber (float)

      Fester abgerechneter Preis.

    • fixed_price_base_unitnumber (float)

      Basiseinheit für den Festpreis.

    • billing_typeBillingItemType

      Typ der Abrechnungsposition.

    • recurrenceCRMRecurrence

      Wiederholung, der die Abrechnungsposition folgt.

    • deletedboolean

      Ob die Abrechnungsposition gelöscht ist.

    • sub_self_service_addboolean

      Ob Mitglieder das Abonnement selbst hinzufügen können.

    • sub_self_service_add_fixed_pricenumber (float)

      Fester Preis, der berechnet wird, wenn Mitglieder das Abo selbst hinzufügen.

    • price_is_bruttoboolean

      Ob die Preise Bruttopreise inklusive Steuer sind.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • is_preferredboolean

      Der Posten ist bevorzugt und wird zuerst angezeigt.

    • is_defaultboolean

      Der Posten ist der Standard für seinen Typ.

    • is_discountboolean

      Der Posten ist ein Rabatt.

    • is_freeboolean

      Der Posten ist kostenfrei.

    • is_passiveboolean

      Der Posten ist passiv und kann nicht mehr ausgewählt werden.

    • is_globalboolean

      Der Posten ist für alle Unternehmen verfügbar.

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels.

  • audiencestring

    Zielgruppe, für die die Probe-Regel gilt, zum Beispiel neue Mitglieder.

  • capacity_modestring

    Wie die Kapazität für Schnuppertermine genutzt wird.

  • quota_per_dateinteger

    Schnupper-Anmeldungen pro Termin mit Kapazitätsmodus own_quota

  • hide_when_fullboolean

    Veranstaltungen ohne freien Platz für Personen mit Schnupper-Interesse ausblenden (sonst angezeigt, aber nicht buchbar)

  • count_modestring

    Wie Schnuppertermine gezählt werden, zum Beispiel pro Person oder pro Event.

  • max_open_sessionsinteger

    Zukünftige Schnuppertermine, die eine Person gleichzeitig halten darf

  • cancel_hoursinteger

    Stunden vor Beginn eines Termins, bis zu denen eine Stornierung den Schnuppertermin zurückgibt

  • check_ageboolean

    Prüft die Altersgrenzen der Veranstaltung (minAge / maxAge) anhand des Geburtstags der Person

  • follow_upstring

    Was nach einer Probezeit passiert, zum Beispiel ein Anmeldeangebot.

  • follow_up_delay_hoursinteger

    Stunden nach dem Ende des letzten Schnuppertermins, bevor die Nachbetreuung beginnt

  • reminder_daysinteger

    Tage nach der Follow-up-Mail für eine Erinnerung, solange die Person nicht konvertiert hat; null = keine

  • membership_urlstring

    Wohin „Mitglied werden“ führt; leer = Einstellung event_trial_membership_url

  • mail_completed_textstring

    Kurztext der E-Mail, die versendet wird, wenn eine Probe abgeschlossen wird.

  • mail_completed_long_textstring

    Langtext der E-Mail, die gesendet wird, wenn ein Probetraining abgeschlossen wird.

  • hold_modestring

    Einen Kursplatz für die Probeperson ab dem ersten Schnuppertermin reservieren (keine = keine Reservierung)

  • hold_daysinteger

    Tage nach dem Ende des letzten Probetermins, an dem der reservierte Platz für die Anmeldung frei bleibt

  • hold_reminder_daysinteger

    Tage vor dem Ende der Sperre für eine Erinnerung; null = keine

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

  • deletedboolean

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

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/event/trial_policy/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "membership_url": "https://vynst.de",
  "mail_completed_text": "Text",
  "mail_completed_long_text": "Text",
  "name": "Beispiel",
  "active": true,
  "max_sessions": 1,
  "scope": "string",
  "validity_days": 1,
  "price_mode": "string"
}

Aktualisiert einen vorhandenen Eintrag der Probe-Richtlinie.

PATCH/api/event/trial_policy/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataTrialPolicy2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200TrialPolicy aktualisierenTrialPolicy

Felder anzeigen (28)
  • idinteger

    Primärschlüssel der Probezeit-Richtlinie. Interne ID.

  • activeboolean

    Die Probezeit-Regelung ist aktiv.

  • max_sessionsinteger

    Anzahl der Probetermine je Durchgang

  • scopestring

    Geltungsbereich der Probe-Regel, zum Beispiel je Veranstaltung oder je Buchbarem.

  • validity_daysinteger

    Tage ab dem ersten Probetermin, in denen der Pass genutzt werden darf; null = kein Limit

  • price_modestring

    Wie der Preis eines Schnuppertermins berechnet wird, zum Beispiel kostenlos oder ermäßigt.

  • productPredefinedBillingItem12

    Produkt, das für eine kostenpflichtige Probe abgerechnet wird (pro Termin oder einmal für den Pass)

    Felder anzeigen (21)
    • idinteger

      Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.

    • namestringPflicht

      Name der Abrechnungsposition.

    • descriptionstringPflicht

      Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.

    • fixed_pricenumber (float)

      Fester abgerechneter Preis.

    • fixed_price_base_unitnumber (float)

      Basiseinheit für den Festpreis.

    • billing_typeBillingItemType

      Typ der Abrechnungsposition.

    • recurrenceCRMRecurrence

      Wiederholung, der die Abrechnungsposition folgt.

    • deletedboolean

      Ob die Abrechnungsposition gelöscht ist.

    • sub_self_service_addboolean

      Ob Mitglieder das Abonnement selbst hinzufügen können.

    • sub_self_service_add_fixed_pricenumber (float)

      Fester Preis, der berechnet wird, wenn Mitglieder das Abo selbst hinzufügen.

    • price_is_bruttoboolean

      Ob die Preise Bruttopreise inklusive Steuer sind.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • is_preferredboolean

      Der Posten ist bevorzugt und wird zuerst angezeigt.

    • is_defaultboolean

      Der Posten ist der Standard für seinen Typ.

    • is_discountboolean

      Der Posten ist ein Rabatt.

    • is_freeboolean

      Der Posten ist kostenfrei.

    • is_passiveboolean

      Der Posten ist passiv und kann nicht mehr ausgewählt werden.

    • is_globalboolean

      Der Posten ist für alle Unternehmen verfügbar.

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels.

  • audiencestring

    Zielgruppe, für die die Probe-Regel gilt, zum Beispiel neue Mitglieder.

  • capacity_modestring

    Wie die Kapazität für Schnuppertermine genutzt wird.

  • quota_per_dateinteger

    Schnupper-Anmeldungen pro Termin mit Kapazitätsmodus own_quota

  • hide_when_fullboolean

    Veranstaltungen ohne freien Platz für Personen mit Schnupper-Interesse ausblenden (sonst angezeigt, aber nicht buchbar)

  • count_modestring

    Wie Schnuppertermine gezählt werden, zum Beispiel pro Person oder pro Event.

  • max_open_sessionsinteger

    Zukünftige Schnuppertermine, die eine Person gleichzeitig halten darf

  • cancel_hoursinteger

    Stunden vor Beginn eines Termins, bis zu denen eine Stornierung den Schnuppertermin zurückgibt

  • check_ageboolean

    Prüft die Altersgrenzen der Veranstaltung (minAge / maxAge) anhand des Geburtstags der Person

  • follow_upstring

    Was nach einer Probezeit passiert, zum Beispiel ein Anmeldeangebot.

  • follow_up_delay_hoursinteger

    Stunden nach dem Ende des letzten Schnuppertermins, bevor die Nachbetreuung beginnt

  • reminder_daysinteger

    Tage nach der Follow-up-Mail für eine Erinnerung, solange die Person nicht konvertiert hat; null = keine

  • membership_urlstring

    Wohin „Mitglied werden“ führt; leer = Einstellung event_trial_membership_url

  • mail_completed_textstring

    Kurztext der E-Mail, die versendet wird, wenn eine Probe abgeschlossen wird.

  • mail_completed_long_textstring

    Langtext der E-Mail, die gesendet wird, wenn ein Probetraining abgeschlossen wird.

  • hold_modestring

    Einen Kursplatz für die Probeperson ab dem ersten Schnuppertermin reservieren (keine = keine Reservierung)

  • hold_daysinteger

    Tage nach dem Ende des letzten Probetermins, an dem der reservierte Platz für die Anmeldung frei bleibt

  • hold_reminder_daysinteger

    Tage vor dem Ende der Sperre für eine Erinnerung; null = keine

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

  • deletedboolean

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

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/event/trial_policy/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "membership_url": "https://vynst.de",
  "mail_completed_text": "Text",
  "mail_completed_long_text": "Text",
  "name": "Beispiel",
  "active": true,
  "max_sessions": 1,
  "scope": "string",
  "validity_days": 1,
  "price_mode": "string"
}

TrialPolicy archivieren (Soft Delete); Veranstaltungen und Kategorien, die sie verwenden, bieten keine Probetermine mehr an, bis sie eine andere Regel erhalten

DELETE/api/event/trial_policy/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200TrialPolicy archivierenTrialPolicy

Felder anzeigen (28)
  • idinteger

    Primärschlüssel der Probezeit-Richtlinie. Interne ID.

  • activeboolean

    Die Probezeit-Regelung ist aktiv.

  • max_sessionsinteger

    Anzahl der Probetermine je Durchgang

  • scopestring

    Geltungsbereich der Probe-Regel, zum Beispiel je Veranstaltung oder je Buchbarem.

  • validity_daysinteger

    Tage ab dem ersten Probetermin, in denen der Pass genutzt werden darf; null = kein Limit

  • price_modestring

    Wie der Preis eines Schnuppertermins berechnet wird, zum Beispiel kostenlos oder ermäßigt.

  • productPredefinedBillingItem12

    Produkt, das für eine kostenpflichtige Probe abgerechnet wird (pro Termin oder einmal für den Pass)

    Felder anzeigen (21)
    • idinteger

      Primärschlüssel der zugeordneten Abrechnungsposition. Interne ID.

    • namestringPflicht

      Name der Abrechnungsposition.

    • descriptionstringPflicht

      Beschreibung des Abrechnungspostens, die dem Kunden angezeigt wird.

    • fixed_pricenumber (float)

      Fester abgerechneter Preis.

    • fixed_price_base_unitnumber (float)

      Basiseinheit für den Festpreis.

    • billing_typeBillingItemType

      Typ der Abrechnungsposition.

    • recurrenceCRMRecurrence

      Wiederholung, der die Abrechnungsposition folgt.

    • deletedboolean

      Ob die Abrechnungsposition gelöscht ist.

    • sub_self_service_addboolean

      Ob Mitglieder das Abonnement selbst hinzufügen können.

    • sub_self_service_add_fixed_pricenumber (float)

      Fester Preis, der berechnet wird, wenn Mitglieder das Abo selbst hinzufügen.

    • price_is_bruttoboolean

      Ob die Preise Bruttopreise inklusive Steuer sind.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • is_preferredboolean

      Der Posten ist bevorzugt und wird zuerst angezeigt.

    • is_defaultboolean

      Der Posten ist der Standard für seinen Typ.

    • is_discountboolean

      Der Posten ist ein Rabatt.

    • is_freeboolean

      Der Posten ist kostenfrei.

    • is_passiveboolean

      Der Posten ist passiv und kann nicht mehr ausgewählt werden.

    • is_globalboolean

      Der Posten ist für alle Unternehmen verfügbar.

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig).

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels.

  • audiencestring

    Zielgruppe, für die die Probe-Regel gilt, zum Beispiel neue Mitglieder.

  • capacity_modestring

    Wie die Kapazität für Schnuppertermine genutzt wird.

  • quota_per_dateinteger

    Schnupper-Anmeldungen pro Termin mit Kapazitätsmodus own_quota

  • hide_when_fullboolean

    Veranstaltungen ohne freien Platz für Personen mit Schnupper-Interesse ausblenden (sonst angezeigt, aber nicht buchbar)

  • count_modestring

    Wie Schnuppertermine gezählt werden, zum Beispiel pro Person oder pro Event.

  • max_open_sessionsinteger

    Zukünftige Schnuppertermine, die eine Person gleichzeitig halten darf

  • cancel_hoursinteger

    Stunden vor Beginn eines Termins, bis zu denen eine Stornierung den Schnuppertermin zurückgibt

  • check_ageboolean

    Prüft die Altersgrenzen der Veranstaltung (minAge / maxAge) anhand des Geburtstags der Person

  • follow_upstring

    Was nach einer Probezeit passiert, zum Beispiel ein Anmeldeangebot.

  • follow_up_delay_hoursinteger

    Stunden nach dem Ende des letzten Schnuppertermins, bevor die Nachbetreuung beginnt

  • reminder_daysinteger

    Tage nach der Follow-up-Mail für eine Erinnerung, solange die Person nicht konvertiert hat; null = keine

  • membership_urlstring

    Wohin „Mitglied werden“ führt; leer = Einstellung event_trial_membership_url

  • mail_completed_textstring

    Kurztext der E-Mail, die versendet wird, wenn eine Probe abgeschlossen wird.

  • mail_completed_long_textstring

    Langtext der E-Mail, die gesendet wird, wenn ein Probetraining abgeschlossen wird.

  • hold_modestring

    Einen Kursplatz für die Probeperson ab dem ersten Schnuppertermin reservieren (keine = keine Reservierung)

  • hold_daysinteger

    Tage nach dem Ende des letzten Probetermins, an dem der reservierte Platz für die Anmeldung frei bleibt

  • hold_reminder_daysinteger

    Tage vor dem Ende der Sperre für eine Erinnerung; null = keine

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

  • deletedboolean

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

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/event/trial_policy/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "membership_url": "https://vynst.de",
  "mail_completed_text": "Text",
  "mail_completed_long_text": "Text",
  "name": "Beispiel",
  "active": true,
  "max_sessions": 1,
  "scope": "string",
  "validity_days": 1,
  "price_mode": "string"
}