Skip to content
Developer

EventSignUp

Events36 EndpointsEvent / EventSignUp

This method will get all BaseEventSignUp Objects

GET/api/event/base_event_signup

Query parameters

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

200Returns a list of BaseEventSignUp objectsarray<BaseEventSignUp10>

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "name": "Beispiel",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "bib_range_id": 42
  }
]

Add a new BaseEventSignUp

POST/api/event/base_event_signup

Responses

200Add a new BaseEventSignUpBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

This method will get a single BaseEventSignUp with the given id or token

GET/api/event/base_event_signup/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single BaseEventSignUpBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

Update a BaseEventSignUp

PUT/api/event/base_event_signup/{identifier}

Path parameters

identifierrequiredstring

Responses

200Update a BaseEventSignUpBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

Update a BaseEventSignUp

PATCH/api/event/base_event_signup/{identifier}

Path parameters

identifierrequiredstring

Responses

200Update a BaseEventSignUpBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

This method will delete a single BaseEventSignUp with the given id or token

DELETE/api/event/base_event_signup/{identifier}

Path parameters

identifierrequiredstring

Responses

200Deletes a single BaseEventSignUpBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

This method will get all BaseEventSignUp Objects for customer

GET/api/event/customer/base_event_signup

Query parameters

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

200Returns a list of BaseEventSignUp objects for customerarray<BaseEventSignUp10>

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/customer/base_event_signup \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "name": "Beispiel",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "bib_range_id": 42
  }
]

Add a new BaseEventSignUp as customer

POST/api/event/customer/base_event_signup

Responses

200Add a new BaseEventSignUp as customerBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/customer/base_event_signup \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

Sign up several persons of the selected company together (e.g. a family for a run)

POST/api/event/customer/base_event_signup_group

All persons are signed up or none: every entry runs the same checks as a single customer sign-up (access, timing, required fields, price incl. member prices) and the event must have a free place for each of them - a group never goes onto the wait list. With direct billing the whole group gets one invoice and one payment. Body: the shared sign-up fields plus sign_ups, one entry per person with person, product (the selected price) and the per-person fields of the event (birthday, allergies, media_questionnaire_answer, invoice_products, ...). Only while the setting event_sign_up_group_enabled is on (iw error 403 otherwise).

Request body application/json

  • dataBaseEventSignUp3
    Show fields (39)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • deletion_reasonstring

      Reason the sign-up was cancelled.

    • direct_billingboolean
    • direct_billing_check_datestring (date-time)
    • direct_billing_tokenstring
    • 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.

    • invoice_productsarray<BaseEventSignUpProductItem>

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

    • self_check_inboolean

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

    • self_check_outboolean

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

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • base_eventBaseEvent21

      Event the entity belongs to.

    • base_bookingBaseBooking21

      Booking the entity belongs to.

Responses

200Sign up several persons of the selected company togetherBaseEventSignUpGroup

Show fields (3)
  • direct_billing_tokenstring

    Token of the invoice to pay online (direct billing): all sign-ups of a group share one invoice.

  • idinteger

    Primary key of the sign-up group. Internal ID.

  • sign_upsarray<BaseEventSignUp18>

    Sign-ups that belong to the group.

    Show fields (41)
    • 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.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/customer/base_event_signup_group \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "support_description": "Text",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "gender": "string"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "direct_billing_token": "string",
  "sign_ups": [
    {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "support_description": "Text",
      "gender": "string",
      "waiting": true,
      "confirmed": true,
      "deletion_reason": "string",
      "direct_billing": true,
      "direct_billing_check_date": "2026-10-15T09:30:00+02:00"
    }
  ]
}

Sign up several persons together as a guest (e.g. a family for a public run)

POST/api/event/public/base_event_signup_group

Like the customer group sign-up, but without a login: every entry carries the participant's own data (first_name, last_name, birthday, ... and the per-person fields of the event); contact, address and payment data are shared and sent once. Only prices without access conditions can be chosen. All or none are signed up, never onto the wait list; with direct billing the group pays one invoice. Only while the setting event_sign_up_group_enabled is on (iw error 403 otherwise).

Request body application/json

  • dataBaseEventSignUp4
    Show fields (56)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • deletion_reasonstring

      Reason the sign-up was cancelled.

    • direct_billingboolean
    • direct_billing_check_datestring (date-time)
    • direct_billing_tokenstring
    • 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.

    • invoice_productsarray<BaseEventSignUpProductItem2>

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

    • self_check_inboolean

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

    • self_check_outboolean

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

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • namestring

      Name of the entity.

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • base_eventBaseEvent22

      Event the entity belongs to.

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference of the SEPA mandate.

    • payment_mandate_sign_datestring (date-time)

      Date the SEPA mandate was signed.

    • payment_mandate_valid_until_datestring (date-time)

      Date until which the SEPA mandate is valid.

    • base_bookingBaseBooking22

      Booking the entity belongs to.

Responses

200Sign up several persons together as a guestBaseEventSignUpGroup

Show fields (3)
  • direct_billing_tokenstring

    Token of the invoice to pay online (direct billing): all sign-ups of a group share one invoice.

  • idinteger

    Primary key of the sign-up group. Internal ID.

  • sign_upsarray<BaseEventSignUp18>

    Sign-ups that belong to the group.

    Show fields (41)
    • 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.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/public/base_event_signup_group \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "support_description": "Text",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "direct_billing_token": "string",
  "sign_ups": [
    {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "support_description": "Text",
      "gender": "string",
      "waiting": true,
      "confirmed": true,
      "deletion_reason": "string",
      "direct_billing": true,
      "direct_billing_check_date": "2026-10-15T09:30:00+02:00"
    }
  ]
}

This method will delete a single BaseEventSignUp for the person in a event

DELETE/api/event/customer/base_event_signup/event/{eventIdentifier}

Path parameters

eventIdentifierrequiredstring

Responses

200Delete a single BaseEventSignUp for the person in a eventBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/event/customer/base_event_signup/event/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

This method will delete a single BaseEventSignUp for the person in a booking

DELETE/api/event/customer/base_event_signup/booking/{bookingIdentifier}

Path parameters

bookingIdentifierrequiredstring

Responses

200Delete a single BaseEventSignUp for the person in a bookingBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/event/customer/base_event_signup/booking/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

Add a new BaseEventSignUp for event or booking as a guest

POST/api/event/public/base_event_signup

Request body application/json

  • dataBaseEventSignUp4
    Show fields (56)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • deletion_reasonstring

      Reason the sign-up was cancelled.

    • direct_billingboolean
    • direct_billing_check_datestring (date-time)
    • direct_billing_tokenstring
    • 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.

    • invoice_productsarray<BaseEventSignUpProductItem2>

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

    • self_check_inboolean

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

    • self_check_outboolean

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

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • namestring

      Name of the entity.

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • base_eventBaseEvent22

      Event the entity belongs to.

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference of the SEPA mandate.

    • payment_mandate_sign_datestring (date-time)

      Date the SEPA mandate was signed.

    • payment_mandate_valid_until_datestring (date-time)

      Date until which the SEPA mandate is valid.

    • base_bookingBaseBooking22

      Booking the entity belongs to.

Responses

200Add a new BaseEventSignUp for event or booking as a guestBaseEventSignUp

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/base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "support_description": "Text",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  }
}
'
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
}

Test adding a new BaseEventSignUp as customer / public

POST/api/event/public/test_base_event_signup

Request body application/json

  • dataBaseEventSignUp3
    Show fields (39)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • deletion_reasonstring

      Reason the sign-up was cancelled.

    • direct_billingboolean
    • direct_billing_check_datestring (date-time)
    • direct_billing_tokenstring
    • 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.

    • invoice_productsarray<BaseEventSignUpProductItem>

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

    • self_check_inboolean

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

    • self_check_outboolean

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

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • base_eventBaseEvent21

      Event the entity belongs to.

    • base_bookingBaseBooking21

      Booking the entity belongs to.

Responses

200Test adding a new BaseEventSignUp as customer / publicBaseEventSignUpTest

Show fields (19)
  • signup_allowedboolean
  • signup_waitlist_allowedboolean
  • signup_delete_allowedboolean
  • signup_after_upgrade_allowedboolean
  • signup_explicitly_disabledboolean
  • signup_require_add_bank_accountboolean
  • signup_requires_loginboolean
  • signup_invoice_address_requiredboolean
  • signup_free_capacitynumber
  • signup_max_capacitynumber
  • signup_fully_bookedboolean

    Only for an event with hidden people limit (globally or per event) and the opt-in setting `event_booking_show_fully_booked_if_people_limit_hidden`: no free place is left. The numbers themselves are never sent for such an event.

  • signup_min_participants_reachedboolean
  • signup_group_availableboolean

    Only with the query param `groupSize`: the event (or booking) has a free place for every person of a group of that size. Groups are never put onto the wait list. Always false while group sign-ups are switched off (`event_sign_up_group_enabled`).

  • signup_require_add_access_tagboolean
  • view_participants_allowedboolean
  • view_participant_grid_allowedboolean
  • can_track_timeboolean
  • signup_via_budgetboolean
  • budget_remainingnumber
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/public/test_base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "support_description": "Text",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "gender": "string"
  }
}
'
Response 200 application/json
{
  "signup_allowed": true,
  "signup_waitlist_allowed": true,
  "signup_delete_allowed": true,
  "signup_after_upgrade_allowed": true,
  "signup_explicitly_disabled": true,
  "signup_require_add_bank_account": true,
  "signup_requires_login": true,
  "signup_invoice_address_required": true,
  "signup_free_capacity": 1.5,
  "signup_max_capacity": 1.5
}

Test adding a new BaseEventSignUp for the person from the admin ui

POST/api/event/admin/test_base_event_signup

Request body application/json

  • dataBaseEventSignUp3
    Show fields (39)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • deletion_reasonstring

      Reason the sign-up was cancelled.

    • direct_billingboolean
    • direct_billing_check_datestring (date-time)
    • direct_billing_tokenstring
    • 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.

    • invoice_productsarray<BaseEventSignUpProductItem>

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

    • self_check_inboolean

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

    • self_check_outboolean

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

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • base_eventBaseEvent21

      Event the entity belongs to.

    • base_bookingBaseBooking21

      Booking the entity belongs to.

Responses

200Test adding a new BaseEventSignUp for the person from the admin uiSuccess

Show fields (3)
  • successboolean
  • messagestring
  • error_codesarray<integer>
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/admin/test_base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "support_description": "Text",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "gender": "string"
  }
}
'
Response 200 application/json
{
  "success": true,
  "message": "string",
  "error_codes": [
    1
  ]
}

Rebook a BaseEventSignUp from one event to another.

POST/api/event/base_event_signup/{identifier}/rebook

This will archive the original signup and create a new one in the target event with the same participant data.

Path parameters

identifierrequiredstring

Responses

200Rebook a BaseEventSignUp from one event to anotherBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup/42/rebook \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

Copy a BaseEventSignUp to another event/booking. The original signup is kept intact.

POST/api/event/base_event_signup/{identifier}/copy

Path parameters

identifierrequiredstring

Responses

200Copy a BaseEventSignUp to another event/bookingBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_event_signup/42/copy \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

Copy all current main-event sign-ups of a BaseEvent into one or more of its bookings.

POST/api/event/base_event/{identifier}/copy_main_signups_to_bookings

Mirrors the behavior of BaseEventCopySignUpToBookingCommand, but runs on demand for user-selected bookings and does not touch the copied_to_booking_until markers used by the automatic generation.

Path parameters

identifierrequiredstring

Responses

200Copy all main-event sign-ups into the given bookingsEventSignUpCopyToBookingsResult

Show fields (5)
  • copiedinteger
  • skipped_existinginteger
  • skipped_fullinteger
  • skipped_otherinteger
  • bookings_processedinteger
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_event/42/copy_main_signups_to_bookings \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "copied": 1,
  "skipped_existing": 1,
  "skipped_full": 1,
  "skipped_other": 1,
  "bookings_processed": 1
}

Confirm a waitlist promotion via token (public, no auth required)

POST/api/event/public/base_event_signup/wait_list_confirm/{token}

Path parameters

tokenrequiredstring

Responses

default

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

Trigger the online payment for a sign up that has no invoice yet

POST/api/event/base_event_signup/{identifier}/request_payment

Writes the missing (proforma) invoice, mails the payment link to the registered person and starts the payment deadline. The same work the scheduled inwendo:billing:direct-billing-request-payment does, for one sign up and without waiting for the next run.

Path parameters

identifierrequiredstring

Responses

200Returns the created invoice, the payment link and the deadline

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

Admin: Confirm a waitlist promotion on behalf of a person

POST/api/event/base_event_signup/{identifier}/wait_list_confirm

Path parameters

identifierrequiredstring

Responses

default

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

Customer: confirm the own (or a household member's) wait list promotion

POST/api/event/customer/base_event_signup/{identifier}/wait_list_confirm

The logged-in counterpart of the public token link: the sign-up must belong to the selected company and one of its persons, a confirmation must be pending and the deadline must not have passed.

Path parameters

identifierrequiredstring

Responses

200Customer: confirm a wait list promotionBaseEventSignUp10

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/customer/base_event_signup/42/wait_list_confirm \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "bib_range_id": 42
}

This method will get all BaseEventSignUp Objects for trainer

GET/api/event/trainer_event/base_event_signup/{eventIdentifier}

Path parameters

eventIdentifierrequiredstring

Query parameters

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

200Returns a list of BaseEventSignUp objects for trainerarray<BaseEventSignUp10>

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/trainer_event/base_event_signup/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "name": "Beispiel",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "bib_range_id": 42
  }
]

This method will get all BaseEventSignUp Objects for trainer with the eventIdentifier and multiple bookings

GET/api/event/trainer_event/bookings_with_base_event_signup/{eventIdentifier}

Path parameters

eventIdentifierrequiredstring

Query parameters

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

default

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

This method will get all BaseEventSignUp Objects for trainer

GET/api/event/trainer_booking/base_event_signup/{bookingIdentifier}

Path parameters

bookingIdentifierrequiredstring

Query parameters

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

200Returns a list of BaseEventSignUp objects for trainer by bookingarray<BaseEventSignUp10>

Show fields (54)
  • bib_range_idinteger
  • age_classstring

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

  • idinteger

    Primary key of the sign-up. Internal ID.

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

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

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

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

  • bib_number_assigned_atstring (date-time)

    Time the bib number was assigned.

  • chip_codestring

    Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.

  • timing_tracking_consentboolean

    Einwilligung in das GPS-Live-Tracking waehrend des Events.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • address_admin_level1string

    First administrative level of the address, e.g. the federal state.

  • address_countrystring

    Country code of the address.

  • address_full_countrystring

    Full name of the country of the address.

  • address_geo_latstring

    Latitude of the address.

  • address_geo_lngstring

    Longitude of the address.

  • address_external_provider_idstring

    field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • namestring

    Name of the entity.

  • main_phonestring

    Main phone number.

  • main_faxstring

    Main fax number.

  • main_emailstring

    Main e-mail address.

  • websitestring

    Website address.

  • deletedboolean

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

  • orderinteger

    Position of the entity in the order.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/trainer_booking/base_event_signup/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "name": "Beispiel",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "bib_range_id": 42
  }
]

Get participant list for a booking with next booking info per participant (same day).

GET/api/event/trainer_booking/base_event_signup_with_next/{bookingIdentifier}

Requires trainerCanViewParticipants AND trainerCanViewNextBooking to be enabled on the event data type.

Path parameters

bookingIdentifierrequiredstring

Responses

default

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

This method will toggle confirmed on BaseEventSignUp Objects for trainer

GET/api/event/trainer_actions/base_event_signup/toggle/{signUpIdentifier}

Path parameters

signUpIdentifierrequiredstring

Responses

default

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

This method will toggle the vaccinated status on BaseEventSignUp Objects for trainer

GET/api/event/trainer_actions/base_event_signup/vaccinated/{signUpIdentifier}

Path parameters

signUpIdentifierrequiredstring

Responses

default

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

This method will toggle the vaccinated status on BaseEventSignUp Objects for trainer

GET/api/event/trainer_actions/base_event_signup/recovered/{signUpIdentifier}

Path parameters

signUpIdentifierrequiredstring

Responses

default

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

This method will update a single field on BaseEventSignUp Objects by trainer

POST/api/event/trainer_actions/base_event_signup/update/{signUpIdentifier}

Path parameters

signUpIdentifierrequiredstring

Responses

default

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

Delete a participant from an entire event (main sign-up + cascades to all future bookings)

POST/api/event/trainer_actions/base_event_signup/delete_for_event/{eventIdentifier}

Path parameters

eventIdentifierrequiredstring

Responses

default

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

This method will add a new BaseEventSignUp for the event by the trainer

GET/api/event/trainer_event/base_event_signup_scan/{eventIdentifier}/{personIdentifier}

Path parameters

eventIdentifierrequiredstring
personIdentifierrequiredstring

Responses

default

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

This method will add a new BaseEventSignUp for the booking by the trainer

GET/api/event/trainer_booking/base_event_signup_scan/{bookingIdentifier}/{personIdentifier}

Path parameters

bookingIdentifierrequiredstring
personIdentifierrequiredstring

Responses

default

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

Test adding a new BaseEventSignUp as trainer

POST/api/event/trainer/test_base_event_signup

Request body application/json

  • dataBaseEventSignUp3
    Show fields (39)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • deletion_reasonstring

      Reason the sign-up was cancelled.

    • direct_billingboolean
    • direct_billing_check_datestring (date-time)
    • direct_billing_tokenstring
    • 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.

    • invoice_productsarray<BaseEventSignUpProductItem>

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

    • self_check_inboolean

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

    • self_check_outboolean

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

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • base_eventBaseEvent21

      Event the entity belongs to.

    • base_bookingBaseBooking21

      Booking the entity belongs to.

Responses

200Test adding a new BaseEventSignUp as trainerBaseEventSignUpTrainerTest

Show fields (4)
  • signup_allowedboolean
  • signup_waitlist_allowedboolean
  • trainer_can_track_timeboolean
  • trainer_can_edit_scoreboardboolean

    The trainer may enter score and match activities (event type allows it and the event has a scoreboard).

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/trainer/test_base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "support_description": "Text",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "gender": "string"
  }
}
'
Response 200 application/json
{
  "signup_allowed": true,
  "signup_waitlist_allowed": true,
  "trainer_can_track_time": true,
  "trainer_can_edit_scoreboard": true
}

Add a new BaseEventSignUp for event or booking as a trainer. Only possible if event billing not required.

POST/api/event/trainer/base_event_signup

Request body application/json

  • dataBaseEventSignUp4
    Show fields (56)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • deletion_reasonstring

      Reason the sign-up was cancelled.

    • direct_billingboolean
    • direct_billing_check_datestring (date-time)
    • direct_billing_tokenstring
    • 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.

    • invoice_productsarray<BaseEventSignUpProductItem2>

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

    • self_check_inboolean

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

    • self_check_outboolean

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

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • namestring

      Name of the entity.

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • base_eventBaseEvent22

      Event the entity belongs to.

    • payment_ownerstring

      Account owner of the direct debit.

    • payment_institutionstring

      Name of the bank of the direct debit.

    • payment_bicstring

      BIC of the bank account.

    • payment_ibanstring

      IBAN of the bank account.

    • payment_mandatestring

      Reference of the SEPA mandate.

    • payment_mandate_sign_datestring (date-time)

      Date the SEPA mandate was signed.

    • payment_mandate_valid_until_datestring (date-time)

      Date until which the SEPA mandate is valid.

    • base_bookingBaseBooking22

      Booking the entity belongs to.

Responses

200Add a new BaseEventSignUp for event or booking as a trainer. Only possible if event billing not required.BaseEventSignUp

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/base_event_signup \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "support_description": "Text",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  }
}
'
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
}

Add a new MassUserNotification for the event signups in referenceIds

POST/api/event/trainer/mass_notification

Request body application/json

  • dataMassUserNotification
    Show fields (16)
    • send_pushboolean

      Whether push notifications should be sent.

    • send_mailboolean

      Whether e-mails should be sent.

    • send_letterboolean

      Whether letters should be sent.

    • send_smsboolean

      Whether SMS messages should be sent.

    • send_whatsappboolean

      Whether WhatsApp messages should be sent.

    • reference_class_namestring

      Class name of the records the notification refers to.

    • reference_idsarray<string>

      IDs of the records the notification refers to.

    • textstring

      The headline of the notification

    • long_textstring

      The text of the notification

    • html_textstring

      The html text of the notification, overrides the long text

    • attachmentsarray<Attachment12>

      Attachments of the mass notification.

    • templateFlexibleLatexTemplate3

      Template used for the mass notification.

    • save_as_attachmentboolean

      Whether the notification is saved as an attachment.

    • check_for_duplicatesboolean

      Whether duplicate recipients are checked.

    • create_questionnaire_draftboolean

      If true, a MediaQuestionnaireAnswer draft is created (or reused) for each referenced BaseEventSignUp recipient, and its fill link is exposed as a template placeholder.

    • questionnaire_draft_questionnaireMediaQuestionnaire3

      The result-list questionnaire the per-recipient drafts are created for.

Responses

200Add a new MassUserNotification for the event signups in referenceIdsMassUserNotification2

Show fields (20)
  • idinteger

    Primary key of the mass notification. Internal ID.

  • processedboolean

    Whether the mass notification has been processed.

  • send_pushboolean

    Whether push notifications should be sent.

  • send_mailboolean

    Whether e-mails should be sent.

  • send_letterboolean

    Whether letters should be sent.

  • send_smsboolean

    Whether SMS messages should be sent.

  • send_whatsappboolean

    Whether WhatsApp messages should be sent.

  • reference_class_namestring

    Class name of the records the notification refers to.

  • reference_idsarray<string>

    IDs of the records the notification refers to.

  • textstring

    The headline of the notification

  • long_textstring

    The text of the notification

  • html_textstring

    The html text of the notification, overrides the long text

  • attachmentsarray<Attachment22>

    Attachments of the mass notification.

    Show fields (26)
    • idinteger

      Primary key of the attachment. Internal ID.

    • filenamestring

      Original file name.

    • filesizestring

      Size of the file in bytes.

    • mimetypestring

      MIME type of the file.

    • createdbyusernamestring

      Name of the user who uploaded the file, as text.

    • createdstring (date-time)

      Point in time the attachment was created.

    • googleidstring

      ID of the file in Google Drive.

    • googledownloadlinkstring

      Download link of the file in Google Drive.

    • scopestring

      Scope that controls who can see the attachment.

    • ocr_document_typestring

      Document type recognized by OCR.

    • ocr_from_namestring

      Sender name recognized by OCR.

    • ocr_from_companystring

      Sender company recognized by OCR.

    • ocr_from_addressstring

      Sender address recognized by OCR.

    • ocr_from_emailstring

      Sender e-mail address recognized by OCR.

    • ocr_from_phonestring

      Sender phone number recognized by OCR.

    • ocr_to_namestring

      Recipient name recognized by OCR.

    • ocr_to_companystring

      Recipient company recognized by OCR.

    • ocr_to_addressstring

      Recipient address recognized by OCR.

    • ocr_to_emailstring

      Recipient e-mail address recognized by OCR.

    • ocr_to_phonestring

      Recipient phone number recognized by OCR.

    • ocr_summarystring

      Summary of the document created by OCR.

    • ocr_statusstring

      OCR processing status: null=not processed, pending, processing, done, error

    • ocr_errorstring

      Reason of the last failed or incomplete OCR run, null when it went through

    • ocr_processed_atstring (date-time)

      Point in time OCR processing finished.

    • virus_checkedboolean

      1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.

    • virus_checked_atstring (date-time)

      When the virus scan passed. Null while the file is still waiting.

  • templateFlexibleLatexTemplate

    Template used for the mass notification.

    Show fields (35)
    • predefinedboolean

      True for templates shipped by the servercontrolpanel (PredefinedFlexibleTemplateMap). Their IDs are referenced by code, so the UI offers to duplicate ("Vorlage anpassen") instead of editing them.

    • data_typestring

      Data type (reference class key) the template is rendered and checked with. For predefined templates (tag IW_PFLT) this is the data type of the code that uses them.

    • data_type_labelstring

      Human readable name of the assigned data type, null for tags that are not a known data type.

    • template_modestring

      Serialized mode so clients do not have to know that null means standard.

    • last_check_statusstring

      Summary of the last template check for list views, the full result is admin detail only.

    • idstring

      Primary key of the template. Internal ID. Used as a string identifier.

    • namestring

      Name of the template.

    • tagstring

      Tag used to group templates.

    • mass_messageboolean

      Whether the template is used for mass messages.

    • default_store_as_pdfboolean

      Whether the generated document is stored as PDF by default.

    • security_scopestring

      Scope that controls who can use the template.

    • security_user_access_typeinteger

      Access type required to use the template.

    • param1string

      Value of parameter 1 used in the template.

    • param2string

      Value of parameter 2 used in the template.

    • param3string

      Value of parameter 3 used in the template.

    • param4string

      Value of parameter 4 used in the template.

    • param5string

      Value of parameter 5 used in the template.

    • param6string

      Value of parameter 6 used in the template.

    • param7string

      Value of parameter 7 used in the template.

    • param8string

      Value of parameter 8 used in the template.

    • param9string

      Value of parameter 9 used in the template.

    • param10string

      Value of parameter 10 used in the template.

    • default_value_param1string

      Default value of parameter 1.

    • default_value_param2string

      Default value of parameter 2.

    • default_value_param3string

      Default value of parameter 3.

    • default_value_param4string

      Default value of parameter 4.

    • default_value_param5string

      Default value of parameter 5.

    • default_value_param6string

      Default value of parameter 6.

    • default_value_param7string

      Default value of parameter 7.

    • default_value_param8string

      Default value of parameter 8.

    • default_value_param9string

      Default value of parameter 9.

    • default_value_param10string

      Default value of parameter 10.

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

  • save_as_attachmentboolean

    Whether the notification is saved as an attachment.

  • check_for_duplicatesboolean

    Whether duplicate recipients are checked.

  • create_questionnaire_draftboolean

    If true, a MediaQuestionnaireAnswer draft is created (or reused) for each referenced BaseEventSignUp recipient, and its fill link is exposed as a template placeholder.

  • questionnaire_draft_questionnaireMediaQuestionnaire

    The result-list questionnaire the per-recipient drafts are created for.

    Show fields (34)
    • idinteger

      Primary key of the questionnaire. Internal ID.

    • questionnaire_typestring

      Type of the questionnaire, for example registration or survey.

    • tokenstring

      Public token of the questionnaire. Used instead of the ID.

    • public_copyrightstring

      Copyright text shown with the questionnaire.

    • public_language_codestring

      Language of the questionnaire, for example de.

    • complexity_levelinteger

      Complexity level of the questionnaire.

    • public_authorstring

      Author shown to the public.

    • show_free_textboolean

      Show a free text field.

    • show_attachmentboolean

      Show an upload field for attachments.

    • require_attachmentboolean

      An attachment must be uploaded.

    • with_paginationboolean

      Show the questionnaire page by page.

    • one_entry_per_personboolean

      If true, only one entry per person is allowed - only for logged-in users and table results

    • require_addressboolean

      The address must be entered.

    • require_contactboolean

      Contact details must be entered.

    • require_ageboolean

      The age must be entered.

    • require_grade_levelboolean

      The school grade level must be entered.

    • start_timestring (date-time)

      Start of the availability of the questionnaire.

    • end_timestring (date-time)

      End of the availability of the questionnaire.

    • age_groupstring

      Age group the questionnaire is intended for.

    • min_ageinteger

      Minimum age in years.

    • max_ageinteger

      Maximum age in years.

    • min_grade_levelinteger

      Minimum school grade level.

    • max_grade_levelinteger

      Maximum school grade level.

    • age_toleranceinteger

      Years by which the age may be outside the range and still be accepted.

    • group_allowedboolean

      Whether the questionnaire is limited to a group.

    • allow_self_registerboolean

      Whether people can register themselves to answer the questionnaire.

    • allow_self_download_result_templateboolean

      Whether answerers can download their own result.

    • clarification_enabledboolean

      Second loop after the AI comparison: answers the AI does not rate as fulfilled become clarification points (MediaQuestionnaireClarification) that are discussed with the customer and decided before the result template is created. Without it the result template follows the AI comparison directly.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

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

    • image_urlstring

      URL of the image of the entity.

    • namestring

      Name of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/trainer/mass_notification \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "send_mail": true,
    "reference_class_name": "Beispiel",
    "text": "Text",
    "long_text": "Text",
    "html_text": "Text",
    "send_push": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "send_mail": true,
  "reference_class_name": "Beispiel",
  "text": "Text",
  "long_text": "Text",
  "html_text": "Text",
  "processed": true,
  "send_push": true,
  "send_letter": true,
  "send_sms": true
}