Skip to content
Developer

Trial (Schnuppern)

Events16 EndpointsEvent / Trial (Schnuppern)

Events the selected person can try out, each with the trial check (remaining dates, reason when it is not bookable right now). Query: person (a person of the selected company, default the user).

GET/api/event/customer/trial/base_event

Query parameters

personintegerPerson of the selected company

Responses

200List of {event, allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status}

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

Trial check for one event and the dates the selected person can book as trial dates.

GET/api/event/customer/trial/base_event/{eventIdentifier}

Path parameters

eventIdentifierrequiredstring

Query parameters

personintegerPerson of the selected company

Responses

200{allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status, dates: [{id, name, start_time, end_time}]}

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

Book a trial date for a person of the selected company. Body: data.baseBooking; query or data.person (default the user).

POST/api/event/customer/trial/base_event_signup

Request body application/json

  • dataobject
    Show fields (2)
    • baseBookinginteger
    • personinteger

Responses

200The trial date sign-upBaseEventSignUp

Show fields (42)
  • idinteger

    Primary key of the sign-up. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • waitingboolean

    The sign-up is on the waiting list.

  • confirmedboolean

    The sign-up is confirmed.

  • deletion_reasonstring

    Reason the sign-up was cancelled.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • allow_photosboolean

    Guardian allows photos of the participant.

  • allow_child_aloneboolean

    Participant may leave alone after the event.

  • authorized_pickupstring

    Persons who are allowed to pick up the participant.

  • needs_supportboolean

    Participant needs support, for example for inclusion.

  • support_descriptionstring

    Description of the support the participant needs.

  • financial_supportboolean

    Participant receives financial support.

  • financial_support_numberstring

    Number of the financial support, for example a voucher.

  • municipal_supportboolean

    Participant receives municipal support.

  • municipal_support_numberstring

    Number of the municipal support.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • self_check_inboolean

    Participant checked in with the self-service check-in.

  • self_check_outboolean

    Participant checked out with the self-service check-out.

  • self_check_in_datestring (date-time)

    Time of the self-service check-in.

  • self_check_out_datestring (date-time)

    Time of the self-service check-out.

  • reminded_of_absencestring (date-time)

    Time the guardian was reminded of an absence.

  • trialboolean

    Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)

  • trial_channelstring

    Who booked the trial date: app, trainer, office

  • trial_session_numberinteger

    Number of this trial date within the pass (1 = first), for "Schnuppern 2/3"

  • trial_session_maxinteger

    Trial dates of the pass, for "Schnuppern 2/3"

  • confirmed_datestring (date-time)

    Time the sign-up was confirmed.

  • bib_numberinteger

    Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.

  • bib_labelstring

    Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.

  • namestring

    Name of the entity.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/customer/trial/base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "baseBooking": 1,
    "person": 1
  }
}
'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "support_description": "Text",
  "name": "Beispiel",
  "gender": "string",
  "waiting": true,
  "confirmed": true,
  "deletion_reason": "string",
  "direct_billing": true
}

Trial passes of the persons of the selected company with their trial dates - for "noch 2 von 3" and the card "Weiter dabei sein?" after the last trial date.

GET/api/event/customer/trial_pass

Query parameters

personintegerOnly this person of the selected company

Responses

200List of {pass, event, sign_ups, hold}

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

Public trial page of an event: the event (by its token, or by id when it is public), whether it can be tried out through the public link and the dates with room for a trial person.

GET/api/event/public/trial/base_event/{eventIdentifier}

Path parameters

eventIdentifierrequiredstring

Responses

200{event, allowed, reason, error_code, trial_max, dates: [{id, name, start_time, end_time}]}

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

Request a trial date through the public link. Body: data.baseBooking, firstName, lastName, birthday (YYYY-MM-DD), mainEmail (the parents'), mainPhone (optional), confirmedPrivacy (must be true).

POST/api/event/public/trial/base_event_signup/{eventIdentifier}

Nothing is booked yet: the parents get a confirmation link by mail (and, when the child is already known, the household's app users by push); the date is booked when they confirm. The answer does not tell whether the person is known.

Path parameters

eventIdentifierrequiredstring

Request body application/json

  • dataobject
    Show fields (7)
    • baseBookinginteger
    • firstNamestring
    • lastNamestring
    • birthdaystring
    • mainEmailstring
    • mainPhonestring
    • confirmedPrivacyboolean

Responses

200{status: 'pending', main_email, expires_at}

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/public/trial/base_event_signup/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "firstName": "Lena",
    "lastName": "Hartmann",
    "baseBooking": 1,
    "birthday": "string",
    "mainEmail": "lena.hartmann@example.org",
    "mainPhone": "string"
  }
}
'

A public trial request by the token of its confirmation link: course, date, the child's name and whether it is still open, confirmed or expired.

GET/api/event/public/trial/request/{token}

Path parameters

tokenrequiredstring

Responses

200{status, expired, expires_at, first_name, last_name, course_name, start_time, end_time}

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

Confirm a public trial request: the date is booked now (all checks run again) and the booking mail is sent. Confirming twice returns the same sign-up; an expired link is refused with 1581.

POST/api/event/public/trial/request/{token}/confirm

Path parameters

tokenrequiredstring

Responses

200The trial date sign-upBaseEventSignUp

Show fields (42)
  • idinteger

    Primary key of the sign-up. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • waitingboolean

    The sign-up is on the waiting list.

  • confirmedboolean

    The sign-up is confirmed.

  • deletion_reasonstring

    Reason the sign-up was cancelled.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • allow_photosboolean

    Guardian allows photos of the participant.

  • allow_child_aloneboolean

    Participant may leave alone after the event.

  • authorized_pickupstring

    Persons who are allowed to pick up the participant.

  • needs_supportboolean

    Participant needs support, for example for inclusion.

  • support_descriptionstring

    Description of the support the participant needs.

  • financial_supportboolean

    Participant receives financial support.

  • financial_support_numberstring

    Number of the financial support, for example a voucher.

  • municipal_supportboolean

    Participant receives municipal support.

  • municipal_support_numberstring

    Number of the municipal support.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • self_check_inboolean

    Participant checked in with the self-service check-in.

  • self_check_outboolean

    Participant checked out with the self-service check-out.

  • self_check_in_datestring (date-time)

    Time of the self-service check-in.

  • self_check_out_datestring (date-time)

    Time of the self-service check-out.

  • reminded_of_absencestring (date-time)

    Time the guardian was reminded of an absence.

  • trialboolean

    Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)

  • trial_channelstring

    Who booked the trial date: app, trainer, office

  • trial_session_numberinteger

    Number of this trial date within the pass (1 = first), for "Schnuppern 2/3"

  • trial_session_maxinteger

    Trial dates of the pass, for "Schnuppern 2/3"

  • confirmed_datestring (date-time)

    Time the sign-up was confirmed.

  • bib_numberinteger

    Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.

  • bib_labelstring

    Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.

  • namestring

    Name of the entity.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/public/trial/request/42/confirm \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "support_description": "Text",
  "name": "Beispiel",
  "gender": "string",
  "waiting": true,
  "confirmed": true,
  "deletion_reason": "string",
  "direct_billing": true
}

Trainer of a date adds a trial person: data.baseBooking plus either data.person (a known person) or firstName, lastName, birthday, mainEmail, mainPhone (found by name and birthday, else created in a new household).

POST/api/event/trainer/trial/base_event_signup

Request body application/json

  • dataobject
    Show fields (7)
    • baseBookinginteger
    • personinteger
    • firstNamestring
    • lastNamestring
    • birthdaystring
    • mainEmailstring
    • mainPhonestring

Responses

200The trial date sign-upBaseEventSignUp

Show fields (42)
  • idinteger

    Primary key of the sign-up. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • waitingboolean

    The sign-up is on the waiting list.

  • confirmedboolean

    The sign-up is confirmed.

  • deletion_reasonstring

    Reason the sign-up was cancelled.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • allow_photosboolean

    Guardian allows photos of the participant.

  • allow_child_aloneboolean

    Participant may leave alone after the event.

  • authorized_pickupstring

    Persons who are allowed to pick up the participant.

  • needs_supportboolean

    Participant needs support, for example for inclusion.

  • support_descriptionstring

    Description of the support the participant needs.

  • financial_supportboolean

    Participant receives financial support.

  • financial_support_numberstring

    Number of the financial support, for example a voucher.

  • municipal_supportboolean

    Participant receives municipal support.

  • municipal_support_numberstring

    Number of the municipal support.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • self_check_inboolean

    Participant checked in with the self-service check-in.

  • self_check_outboolean

    Participant checked out with the self-service check-out.

  • self_check_in_datestring (date-time)

    Time of the self-service check-in.

  • self_check_out_datestring (date-time)

    Time of the self-service check-out.

  • reminded_of_absencestring (date-time)

    Time the guardian was reminded of an absence.

  • trialboolean

    Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)

  • trial_channelstring

    Who booked the trial date: app, trainer, office

  • trial_session_numberinteger

    Number of this trial date within the pass (1 = first), for "Schnuppern 2/3"

  • trial_session_maxinteger

    Trial dates of the pass, for "Schnuppern 2/3"

  • confirmed_datestring (date-time)

    Time the sign-up was confirmed.

  • bib_numberinteger

    Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.

  • bib_labelstring

    Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.

  • namestring

    Name of the entity.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/trainer/trial/base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "firstName": "Lena",
    "lastName": "Hartmann",
    "baseBooking": 1,
    "person": 1,
    "birthday": "string",
    "mainEmail": "lena.hartmann@example.org"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "support_description": "Text",
  "name": "Beispiel",
  "gender": "string",
  "waiting": true,
  "confirmed": true,
  "deletion_reason": "string",
  "direct_billing": true
}

Trial check for one event and a person, with the dates the person can book as trial dates.

GET/api/event/trial/base_event/{eventIdentifier}/check

Path parameters

eventIdentifierrequiredstring

Query parameters

personrequiredintegerCRMPerson

Responses

200{allowed, reason, error_code, trial_max, trial_used, trial_remaining, trial_status, dates}

Request
curl --request GET \
  --url 'https://your-instance.iw-erp.de/api/event/trial/base_event/42/check?person=1' \
  --header 'x-iw-jwt-token: <TOKEN>'

The office books a trial date for a person. Body: data.baseBooking, data.person.

POST/api/event/trial/base_event_signup

Request body application/json

  • dataobject
    Show fields (2)
    • baseBookinginteger
    • personinteger

Responses

200The trial date sign-upBaseEventSignUp7

Show fields (56)
  • bib_range_idinteger
  • ticketSeatLabelstring

    Label of the booked seat ("row-number"), for tickets, check-in and the ticket overview.

  • age_classstring

    Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.

  • idinteger

    Primary key of the sign-up. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • tokenstring

    Public token of the sign-up. Used in links instead of the ID.

  • moments_tokenstring

    Participant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.

  • waitingboolean

    The sign-up is on the waiting list.

  • confirmedboolean

    The sign-up is confirmed.

  • age_statusstring

    Age status of a course sign-up against the age limits of the course (AgeLimits::STATUS_*), kept by AgeCheckService; null = not checked (date and trial sign-ups, courses without limits, feature off). Only for the office.

  • age_status_monthsinteger

    Months beyond the nearer age limit at the last check (positive = older, negative = younger)

  • age_status_changed_atstring (date-time)

    Time the age status of the participant last changed.

  • age_notified_atstring (date-time)

    When the office was told about the current age status (digest)

  • externalboolean

    The sign-up was made by an external party.

  • deletion_reasonstring

    Reason the sign-up was cancelled.

  • billedboolean

    The sign-up was billed.

  • direct_billingboolean
  • direct_billing_check_datestring (date-time)
  • direct_billing_tokenstring
  • wait_list_confirmation_tokenstring
  • wait_list_confirmation_sent_atstring (date-time)
  • wait_list_confirmation_deadlinestring (date-time)
  • wait_list_confirmed_atstring (date-time)
  • wait_list_pending_confirmationboolean
  • wait_list_sort_orderinteger
  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • allow_photosboolean

    Guardian allows photos of the participant.

  • allow_child_aloneboolean

    Participant may leave alone after the event.

  • authorized_pickupstring

    Persons who are allowed to pick up the participant.

  • needs_supportboolean

    Participant needs support, for example for inclusion.

  • support_descriptionstring

    Description of the support the participant needs.

  • financial_supportboolean

    Participant receives financial support.

  • financial_support_numberstring

    Number of the financial support, for example a voucher.

  • municipal_supportboolean

    Participant receives municipal support.

  • municipal_support_numberstring

    Number of the municipal support.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • confirmed_disclaimerboolean

    Participant confirmed the disclaimer.

  • confirmed_privacyboolean

    Participant confirmed the privacy policy.

  • confirmed_cancellation_policyboolean

    Participant confirmed the cancellation policy.

  • free_note_onestring

    Free note 1 entered on the sign-up.

  • free_note_twostring

    Free note 2 entered on the sign-up.

  • free_note_threestring

    Free note 3 entered on the sign-up.

  • free_note_fourstring

    Free note 4 entered on the sign-up.

  • productPredefinedBillingItem13

    Product the sign-up is billed with.

    Show fields (81)
    • idinteger

      Primary key of the mapped billing item. Internal ID.

    • namestringrequired

      Name of the billing item.

    • descriptionstringrequired

      Description of the billing item shown to the customer.

    • internal_descriptionstring

      Internal description of the billing item, not shown to the customer.

    • fixed_hoursnumber (float)

      Fixed number of hours billed.

    • fixed_pricenumber (float)

      Fixed price billed.

    • fixed_price_base_unitnumber (float)

      Base unit for the fixed price.

    • price_fixed_hoursnumber (float)

      Price for the fixed hours.

    • price_additional_hoursnumber (float)

      Price for each additional hour.

    • name_additional_hoursstring

      Name of the additional hours item.

    • description_additional_hoursstring

      Description of the additional hours item.

    • time_billed_on_ticket_closeboolean

      Whether the time is billed when the ticket is closed.

    • billing_typeBillingItemType

      Billing item type.

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

    • deletedboolean

      Whether the billing item is deleted.

    • condition_date_afterstring (date-time)

      The item applies only to dates after this date.

    • condition_date_beforestring (date-time)

      The item applies only to dates before this date.

    • condition_country_codestring

      Country code the item applies to.

    • condition_zip_code_fromstring

      Start of the postal code range the item applies to.

    • condition_zip_code_tostring

      End of the postal code range the item applies to.

    • condition_time_after_hourinteger

      The item applies only after this hour of the day.

    • condition_max_lengthinteger

      Maximum length the item applies to.

    • condition_time_before_hourinteger

      The item applies only before this hour of the day.

    • condition_sub_access_tagAccessTag

      Access tag a subscription must have for the item to apply.

    • condition_show_despite_missing_access_tagboolean

      Whether the item is shown even if the access tag is missing.

    • condition_sub_free_logicstring

      Free-form condition logic for the subscription.

    • fixed_price_logicstring

      Free-form logic that calculates the fixed price.

    • sub_self_service_addboolean

      Whether members can add the subscription themselves.

    • sub_self_service_deleteboolean

      Whether members can cancel the subscription themselves.

    • sub_self_service_add_fixed_pricenumber (float)

      Fixed price charged when members add the subscription themselves.

    • sub_self_service_delete_fixed_pricenumber (float)

      Fixed price charged when members cancel the subscription themselves.

    • sub_pre_paidboolean

      Whether the subscription is paid in advance.

    • sub_only_billed_after_startboolean

      Whether the subscription is only billed after its start date.

    • sub_people_age_group_oneinteger

      Upper age limit of age group one.

    • sub_people_age_group_one_discountinteger

      Discount in percent for age group one.

    • sub_people_age_group_one_freeinteger

      Number of free places for age group one.

    • sub_people_age_group_twointeger

      Upper age limit of age group two.

    • sub_people_age_group_two_discountinteger

      Discount in percent for age group two.

    • sub_people_age_group_two_freeinteger

      Number of free places for age group two.

    • sub_people_age_group_threeinteger

      Upper age limit of age group three.

    • sub_people_age_group_three_discountinteger

      Discount in percent for age group three.

    • sub_people_age_group_three_freeinteger

      Number of free places for age group three.

    • sub_people_age_group_fourinteger

      Upper age limit of age group four.

    • sub_people_age_group_four_discountinteger

      Discount in percent for age group four.

    • sub_people_age_group_four_freeinteger

      Number of free places for age group four.

    • price_is_bruttoboolean

      Whether the prices are gross prices including tax.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • companyCRMCompany

      Company the billing item belongs to.

    • parentPredefinedBillingItem13

      Parent billing item, for example for variants.

    • is_preferredboolean

      The item is preferred and shown first.

    • is_defaultboolean

      The item is the default for its type.

    • is_discountboolean

      The item is a discount.

    • is_freeboolean

      The item is free of charge.

    • is_passiveboolean

      The item is passive and cannot be selected anymore.

    • is_globalboolean

      The item is available for all companies.

    • inventory_countinteger

      Number of pieces in stock, if the item is a product.

    • stock_itemboolean

      This is flag for items that can be ordered at any time

    • 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 guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels. Producer / brand offering the commercial guarantee of durability.

    • energy_label_attachmentAttachment10

      Energielabel (EU Energieverbrauchskennzeichnung) als Bild/PDF fuer Shop, Warenkorb und Mail. EU energy label image/PDF of this product.

    • garan_label_attachmentAttachment10

      Grosses EU GARAN Label (DVO 2025/1960): kostenlose Haltbarkeitsgarantie des Herstellers von mehr als zwei Jahren, mit Jahren, Marke und Modell. Full EU GARAN label (commercial guarantee of durability > 2 years).

    • garan_label_pictogram_attachmentAttachment10

      "Nested label" / Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick/Hover muss das grosse Label (garanLabelAttachment) erscheinen. EU GARAN "nested label" pictogram showing only the years; links to the full label online.

    • public_categorystring

      Category of the item shown publicly.

    • condition_booking_content_typeBookingContentType18

      Item applies only to bookings with this content type (e.g. flight type). Null = all content types.

    • usage_time_baseinteger

      Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or BILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.

    • base_locationBaseLocation10

      Location this charge belongs to (e.g. airport landing/takeoff fee), category CATEGORY_LOCATION

    • condition_day_of_week_maskinteger

      Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.

    • condition_first_usage_onlyboolean

      Charge applies only once per usage record (first matching section, quantity 1)

    • budget_grant_countinteger

      Number of event sign-ups this product grants when purchased (null = no budget)

    • budget_create_onceboolean

      If true, budget is only created once per person+product combination. For recurring subscriptions: monthly payment but yearly budget.

    • ticket_quotainteger

      Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis). Null = nur das Teilnehmerlimit des Events zählt.

    • ticket_sale_startstring (date-time)

      Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Frühbucher ab), null = sofort.

    • ticket_sale_endstring (date-time)

      Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Frühbucher bis), null = bis zum Anmeldeschluss.

    • ticket_seat_zonestring

      Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur für Plätze dieser Preiszone (BaseLocationPlanItem::seatZone), null = für jeden Platz.

    • cancellation_term_unitstring

      Allowed cancellation terms for this subscription product. Null / empty = inherit the club default from settings. See CancellationTermCalculator::TERM_UNITS.

    • cancellation_term_datesstring

      Comma separated list of fixed cancellation dates in DD.MM format, e.g. "31.03,30.06,30.09,31.12". Only used when cancellationTermUnit is CUSTOM.

    • cancellation_notice_valueinteger

      Numeric value of the notice period before the cancellation term. Null = inherit from settings.

    • cancellation_notice_unitstring

      Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.

    • … 6 more fields
  • invoice_productsarray<BaseEventSignUpProductItem3>

    Product items added to the invoice of the sign-up.

    Show fields (5)
    • idinteger

      Primary key of the product item. Internal ID.

    • event_sign_upBaseEventSignUp7

      Sign-up the product item belongs to.

    • productPredefinedBillingItem13

      Product that is billed.

    • quantitynumber (float)

      Quantity of the product.

    • billedboolean

      The product item was billed.

  • generate_date_endstring (date-time)

    End date of the generated bookings for the sign-up.

  • variantBaseEventVariant

    Event variant the sign-up belongs to.

    Show fields (4)
    • idinteger

      Primary key of the event variant. Internal ID.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • namestring

      Name of the entity.

    • image_urlstring

      URL of the image of the entity.

  • invitationBaseEventInvitation5

    Invitation the sign-up was made with.

    Show fields (9)
    • idinteger

      Primary key of the invitation. Internal ID.

    • readboolean

      The invitation was read.

    • messagestring

      Message sent with the invitation.

    • reply_messagestring

      Reply message of the invited person.

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • orderinteger

      Position of the entity in the order.

  • event_access_budgetEventAccessBudget4

    Access budget used for the sign-up.

    Show fields (19)
    • idinteger

      Primary key of the event access budget. Internal ID.

    • personCRMPerson10

      Person the budget belongs to.

    • total_budgetinteger

      Total number of sign-ups granted (e.g. 10 for a 10er Karte)

    • used_budgetinteger

      Number of sign-ups already consumed

    • valid_fromstring (date-time)

      Start of the budget period.

    • valid_untilstring (date-time)

      End of the budget period.

    • base_eventBaseEvent25

      Scope: limit budget to a specific event

    • unified_categoryUnifiedCategory41

      Scope: limit budget to events of this unified category

    • event_typestring

      Scope: limit budget to events of this event type (WORKSHOP, CAMP, COURSE, etc.)

    • source_typestring

      How this budget was created: 'purchase', 'bonus', 'manual'

    • trial_policyTrialPolicy6

      Rule of a trial pass (sourceType trial)

    • trial_statusstring

      active, exhausted (all dates used and over), converted (course place or membership), expired (validity over), cancelled (ended by the office)

    • trial_exhausted_atstring (date-time)

      Time all trial places were used.

    • trial_follow_up_sent_atstring (date-time)

      Time the follow-up after the trial was sent.

    • trial_reminder_sent_atstring (date-time)

      Time the trial reminder was sent.

    • trial_converted_atstring (date-time)

      Time the trial was converted into a membership.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • media_questionnaire_answerMediaQuestionnaireAnswer11

    Answer to the questionnaire of the event.

    Show fields (29)
    • idinteger

      Primary key of the questionnaire answer. Internal ID.

    • genderstring

      Gender of the participant.

    • confirmedboolean

      The answer is confirmed.

    • draftboolean

      The answer is a draft and not yet submitted.

    • processingboolean

      The answer is being processed.

    • externalboolean

      The answer was given by an external party.

    • birthdaystring (date-time)

      Birthday of the participant.

    • known_allergiesstring

      Known allergies of the participant.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • grade_levelinteger

      School grade level of the participant.

    • school_classstring

      School class of the participant.

    • review_statusstring

      Second loop after the AI comparison (MediaQuestionnaire::$clarificationEnabled), null without it: CLARIFICATION_PENDING while the comparison / the generation of the clarification points runs, CLARIFICATION_OPEN while points are open, COMPLETED once the review is finished and the result template may be created.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • role_in_companystring

      Role/position of the respondent in the company

    • start_in_companystring

      When the respondent started working at the company

    • company_namestring

      When the respondent started working at the company

    • answer_durationinteger

      Duration in seconds the respondent took to complete the questionnaire

    • billedboolean

      The answer was billed.

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

    • … 17 more fields
  • … 44 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/trial/base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "baseBooking": 1,
    "person": 1
  }
}
'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "support_description": "Text",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}

Trial passes (Schnupper-Kontingente) with their trial dates. Filters: person, baseEvent, unifiedCategory, trialPolicy, trialStatus.

GET/api/event/trial_pass

Query parameters

personinteger
baseEventinteger
unifiedCategoryinteger
trialPolicyinteger
trialStatusstring
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200List of {pass, event, sign_ups}

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

Office action on a trial pass: convert (course place / membership arranged elsewhere), cancel (end the trial, no further dates) or reset (a fresh pass: dates and follow-up start over).

POST/api/event/trial_pass/{identifier}/{passAction}

Path parameters

identifierrequiredstring
passActionrequiredstringAllowed: convertcancelreset

Responses

200{pass, event, sign_ups}

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

Course places held for trial persons (Schnupper-Reservierungen) with the trial dates of their pass, for the participant list of a course and the office. Filters: status (default: open ones - held, pending, secured; "all" for every state), baseEvent, person, pass.

GET/api/event/trial_hold

Query parameters

statusstring
baseEventinteger
personinteger
passinteger

Responses

200List of {hold, person, sign_ups, dates: [{sign_up_id, booking_id, start_time, end_time, deleted, present, trial_session_number, trial_session_max}]}

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

Office action on a held course place: secure (no deadline), convert (regular sign-up with the normal confirmation mail), extend (data.days or query days, default 7) or release (the place is free again, the wait list moves up).

POST/api/event/trial_hold/{identifier}/{holdAction}

Path parameters

identifierrequiredstring
holdActionrequiredstringAllowed: secureconvertextendrelease

Query parameters

daysinteger

Responses

200{hold, person, sign_ups}

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