Skip to content
Developer

MediaQuestionnaire

Media7 EndpointsMedia / MediaQuestionnaire

This method will get all MediaQuestionnaire

GET/api/media/questionnaire

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 MediaQuestionnaire objectsarray<MediaQuestionnaire>

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.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/questionnaire \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "show_free_text": true,
    "image_url": "https://vynst.de",
    "name": "Beispiel",
    "questionnaire_type": "string",
    "token": "string",
    "public_copyright": "string",
    "public_language_code": "string",
    "complexity_level": 1,
    "public_author": "string"
  }
]

Add a new MediaQuestionnaire

POST/api/media/questionnaire

Responses

200Add a new MediaQuestionnaireMediaQuestionnaire2

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

  • pagesarray<MediaQuestionnairePage>

    Pages of the questionnaire.

    Show fields (12)
    • idinteger

      Primary key of the questionnaire page. Internal ID.

    • page_numberinteger

      Number of the page within the questionnaire.

    • page_progress_statusstring

      Progress status shown for the page.

    • answer_requiredboolean

      If true, at least one answer is required

    • previous_answer_requiredboolean

      If true, the page is only shown if the previous question was answered

    • previous_answer_referencestring

      Reference to the previous answer content

    • content_hintstring

      Hint text shown on the page.

    • submenu_titlestring

      Title of the submenu entry for the page.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • image_urlstring

      URL of the image of the entity.

  • entriesarray<MediaQuestionnaireContent>

    Questions and contents of the questionnaire.

    Show fields (17)
    • idinteger

      Primary key of the questionnaire content. Internal ID.

    • contentstring

      Question or text of the content.

    • content_keystring

      Stable key of the question: never changes once set (text, type and position may change), unique within the questionnaire and copied to MediaQuestionnaireContentAnswer::$contentKey. Filled by MediaQuestionnaireContentKeyListener.

    • content_hintstring

      Hint for the answer.

    • content_filterstring

      Filter of the content, for example which answers are allowed.

    • public_titlestring

      Title of the content shown to the public.

    • answerstring

      Given answer

    • answer_liststring

      Answer list for dropdowns or radio buttons. Divided by new line. Inner values divided by | to separate value and label

    • answer_requiredboolean

      If true, the answer is required

    • previous_answer_requiredboolean

      If true, the question is only shown if the previous question was answered

    • previous_answer_referencestring

      Reference to the previous answer content

    • answer_in_titleboolean

      If true, the answer is added to the title

    • answer_in_tableboolean

      If true, the answer is added to the result table (if available)

    • page_numberinteger

      Page of the questionnaire the content is on.

    • content_typestring

      Type of the content, for example text, choice or upload.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • notification_emailstring

    Recipient(s) of the management notification mail sent on each new answer. Multiple addresses can be provided comma-separated (e.g. "a@x.de, b@y.de").

  • notification_textstring

    Short text of the notification sent after answering.

  • notification_long_textstring

    Long text of the notification sent after answering.

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

  • eventsarray<BaseEvent24>

    Events the questionnaire belongs to.

    Show fields (81)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • media_questionnaireMediaQuestionnaire2

      Questionnaire of the event in the media module.

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • scoreboard_sportstring

      Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.

    • scoreboard_home_namestring

      Name of the home team on the scoreboard.

    • scoreboard_away_namestring

      Name of the away team on the scoreboard.

    • ticket_sales_enabledboolean

      Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.

    • ticket_max_per_orderinteger

      Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.

    • ticket_personalizedboolean

      Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.

    • ticket_seatingboolean

      Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.

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

    • … 20 more fields
  • ai_chat_promptstring

    The system prompt for the AI bot. The prompt will be suffixed by the MediaQuestionnaireContent in entries to give the AI a context of what questions we would like answers to at the end of the chat. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_optimizer_promptstring

    The system prompt for the AI bot. The prompt will be used to optimize the chat prompt with existing context. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_auto_close_secret_wordstring

    A word as the last part of an AI chat reply that will close the chat and trigger a completion of the questionnaire. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_completed_promptstring

    The system prompt for the AI bot that takes all chat messages and the MediaQuestionnaireContent in entries to generate an answer to each of the questions. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_answer_summary_promptstring

    The system prompt for the AI bot that takes the answer to each question and generates a summary / wiki article of the answers. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • required_previous_questionnaireMediaQuestionnaire2

    Questionnaire that must be answered first.

  • group_allowedboolean

    Whether the questionnaire is limited to a group.

  • allow_self_registerboolean

    Whether people can register themselves to answer the questionnaire.

  • result_templateFlexibleLatexTemplate

    Template used to render the result of the questionnaire.

    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.

  • auto_send_result_templateboolean

    Whether the result is sent automatically after an answer is given.

  • allow_self_download_result_templateboolean

    Whether answerers can download their own result.

  • answer_productPredefinedBillingItem14

    Product used for billing individual questionnaire answers

    Show fields (15)
    • idinteger

      Primary key of the mapped billing item. Internal ID.

    • namestringrequired

      Name of the billing item.

    • descriptionstringrequired

      Description of the billing item shown to the customer.

    • internal_descriptionstring

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

    • fixed_hoursnumber (float)

      Fixed number of hours billed.

    • fixed_pricenumber (float)

      Fixed price billed.

    • fixed_price_base_unitnumber (float)

      Base unit for the fixed price.

    • price_fixed_hoursnumber (float)

      Price for the fixed hours.

    • price_additional_hoursnumber (float)

      Price for each additional hour.

    • name_additional_hoursstring

      Name of the additional hours item.

    • description_additional_hoursstring

      Description of the additional hours item.

    • time_billed_on_ticket_closeboolean

      Whether the time is billed when the ticket is closed.

    • billing_typeBillingItemType

      Billing item type.

    • buying_pricenumber (float)

      Purchase price of the item.

    • … 73 more fields
  • … 15 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/questionnaire \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "show_free_text": true,
  "notification_email": "lena.hartmann@example.org",
  "notification_text": "Text",
  "notification_long_text": "Text",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string"
}

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

GET/api/media/questionnaire/{identifier}

Path parameters

identifierrequiredstring

Query parameters

draftTokenstringToken (logged in: id or token) of an own draft answer for this questionnaire - grants read access even without access tags

Responses

200Returns a single MediaQuestionnaireMediaQuestionnaire

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.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/questionnaire/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "show_free_text": true,
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string",
  "public_language_code": "string",
  "complexity_level": 1,
  "public_author": "string"
}

Update a MediaQuestionnaire

PUT/api/media/questionnaire/{identifier}

Path parameters

identifierrequiredstring

Responses

200Update a MediaQuestionnaireMediaQuestionnaire2

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

  • pagesarray<MediaQuestionnairePage>

    Pages of the questionnaire.

    Show fields (12)
    • idinteger

      Primary key of the questionnaire page. Internal ID.

    • page_numberinteger

      Number of the page within the questionnaire.

    • page_progress_statusstring

      Progress status shown for the page.

    • answer_requiredboolean

      If true, at least one answer is required

    • previous_answer_requiredboolean

      If true, the page is only shown if the previous question was answered

    • previous_answer_referencestring

      Reference to the previous answer content

    • content_hintstring

      Hint text shown on the page.

    • submenu_titlestring

      Title of the submenu entry for the page.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • image_urlstring

      URL of the image of the entity.

  • entriesarray<MediaQuestionnaireContent>

    Questions and contents of the questionnaire.

    Show fields (17)
    • idinteger

      Primary key of the questionnaire content. Internal ID.

    • contentstring

      Question or text of the content.

    • content_keystring

      Stable key of the question: never changes once set (text, type and position may change), unique within the questionnaire and copied to MediaQuestionnaireContentAnswer::$contentKey. Filled by MediaQuestionnaireContentKeyListener.

    • content_hintstring

      Hint for the answer.

    • content_filterstring

      Filter of the content, for example which answers are allowed.

    • public_titlestring

      Title of the content shown to the public.

    • answerstring

      Given answer

    • answer_liststring

      Answer list for dropdowns or radio buttons. Divided by new line. Inner values divided by | to separate value and label

    • answer_requiredboolean

      If true, the answer is required

    • previous_answer_requiredboolean

      If true, the question is only shown if the previous question was answered

    • previous_answer_referencestring

      Reference to the previous answer content

    • answer_in_titleboolean

      If true, the answer is added to the title

    • answer_in_tableboolean

      If true, the answer is added to the result table (if available)

    • page_numberinteger

      Page of the questionnaire the content is on.

    • content_typestring

      Type of the content, for example text, choice or upload.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • notification_emailstring

    Recipient(s) of the management notification mail sent on each new answer. Multiple addresses can be provided comma-separated (e.g. "a@x.de, b@y.de").

  • notification_textstring

    Short text of the notification sent after answering.

  • notification_long_textstring

    Long text of the notification sent after answering.

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

  • eventsarray<BaseEvent24>

    Events the questionnaire belongs to.

    Show fields (81)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • media_questionnaireMediaQuestionnaire2

      Questionnaire of the event in the media module.

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • scoreboard_sportstring

      Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.

    • scoreboard_home_namestring

      Name of the home team on the scoreboard.

    • scoreboard_away_namestring

      Name of the away team on the scoreboard.

    • ticket_sales_enabledboolean

      Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.

    • ticket_max_per_orderinteger

      Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.

    • ticket_personalizedboolean

      Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.

    • ticket_seatingboolean

      Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.

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

    • … 20 more fields
  • ai_chat_promptstring

    The system prompt for the AI bot. The prompt will be suffixed by the MediaQuestionnaireContent in entries to give the AI a context of what questions we would like answers to at the end of the chat. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_optimizer_promptstring

    The system prompt for the AI bot. The prompt will be used to optimize the chat prompt with existing context. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_auto_close_secret_wordstring

    A word as the last part of an AI chat reply that will close the chat and trigger a completion of the questionnaire. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_completed_promptstring

    The system prompt for the AI bot that takes all chat messages and the MediaQuestionnaireContent in entries to generate an answer to each of the questions. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_answer_summary_promptstring

    The system prompt for the AI bot that takes the answer to each question and generates a summary / wiki article of the answers. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • required_previous_questionnaireMediaQuestionnaire2

    Questionnaire that must be answered first.

  • group_allowedboolean

    Whether the questionnaire is limited to a group.

  • allow_self_registerboolean

    Whether people can register themselves to answer the questionnaire.

  • result_templateFlexibleLatexTemplate

    Template used to render the result of the questionnaire.

    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.

  • auto_send_result_templateboolean

    Whether the result is sent automatically after an answer is given.

  • allow_self_download_result_templateboolean

    Whether answerers can download their own result.

  • answer_productPredefinedBillingItem14

    Product used for billing individual questionnaire answers

    Show fields (15)
    • idinteger

      Primary key of the mapped billing item. Internal ID.

    • namestringrequired

      Name of the billing item.

    • descriptionstringrequired

      Description of the billing item shown to the customer.

    • internal_descriptionstring

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

    • fixed_hoursnumber (float)

      Fixed number of hours billed.

    • fixed_pricenumber (float)

      Fixed price billed.

    • fixed_price_base_unitnumber (float)

      Base unit for the fixed price.

    • price_fixed_hoursnumber (float)

      Price for the fixed hours.

    • price_additional_hoursnumber (float)

      Price for each additional hour.

    • name_additional_hoursstring

      Name of the additional hours item.

    • description_additional_hoursstring

      Description of the additional hours item.

    • time_billed_on_ticket_closeboolean

      Whether the time is billed when the ticket is closed.

    • billing_typeBillingItemType

      Billing item type.

    • buying_pricenumber (float)

      Purchase price of the item.

    • … 73 more fields
  • … 15 more fields
Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/media/questionnaire/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "show_free_text": true,
  "notification_email": "lena.hartmann@example.org",
  "notification_text": "Text",
  "notification_long_text": "Text",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string"
}

Update a MediaQuestionnaire

PATCH/api/media/questionnaire/{identifier}

Path parameters

identifierrequiredstring

Responses

200Update a MediaQuestionnaireMediaQuestionnaire2

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

  • pagesarray<MediaQuestionnairePage>

    Pages of the questionnaire.

    Show fields (12)
    • idinteger

      Primary key of the questionnaire page. Internal ID.

    • page_numberinteger

      Number of the page within the questionnaire.

    • page_progress_statusstring

      Progress status shown for the page.

    • answer_requiredboolean

      If true, at least one answer is required

    • previous_answer_requiredboolean

      If true, the page is only shown if the previous question was answered

    • previous_answer_referencestring

      Reference to the previous answer content

    • content_hintstring

      Hint text shown on the page.

    • submenu_titlestring

      Title of the submenu entry for the page.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • image_urlstring

      URL of the image of the entity.

  • entriesarray<MediaQuestionnaireContent>

    Questions and contents of the questionnaire.

    Show fields (17)
    • idinteger

      Primary key of the questionnaire content. Internal ID.

    • contentstring

      Question or text of the content.

    • content_keystring

      Stable key of the question: never changes once set (text, type and position may change), unique within the questionnaire and copied to MediaQuestionnaireContentAnswer::$contentKey. Filled by MediaQuestionnaireContentKeyListener.

    • content_hintstring

      Hint for the answer.

    • content_filterstring

      Filter of the content, for example which answers are allowed.

    • public_titlestring

      Title of the content shown to the public.

    • answerstring

      Given answer

    • answer_liststring

      Answer list for dropdowns or radio buttons. Divided by new line. Inner values divided by | to separate value and label

    • answer_requiredboolean

      If true, the answer is required

    • previous_answer_requiredboolean

      If true, the question is only shown if the previous question was answered

    • previous_answer_referencestring

      Reference to the previous answer content

    • answer_in_titleboolean

      If true, the answer is added to the title

    • answer_in_tableboolean

      If true, the answer is added to the result table (if available)

    • page_numberinteger

      Page of the questionnaire the content is on.

    • content_typestring

      Type of the content, for example text, choice or upload.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • notification_emailstring

    Recipient(s) of the management notification mail sent on each new answer. Multiple addresses can be provided comma-separated (e.g. "a@x.de, b@y.de").

  • notification_textstring

    Short text of the notification sent after answering.

  • notification_long_textstring

    Long text of the notification sent after answering.

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

  • eventsarray<BaseEvent24>

    Events the questionnaire belongs to.

    Show fields (81)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • event_people_min_limitinteger

      minimum number of people that must attend the event

    • hide_event_people_limitboolean

      a setting to hide the event people limit in the frontend ui

    • event_people_recovered_vaccinated_limitinteger

      Maximum number of recovered or vaccinated participants.

    • event_people_not_recovered_vaccinated_limitinteger

      Maximum number of participants who are neither recovered nor vaccinated.

    • has_wait_listboolean

      The event has a waiting list once it is full.

    • wait_list_confirmation_requiredboolean

      Participants from the waiting list must confirm their place.

    • trial_enabledboolean

      Trial sessions (Schnuppern) are offered for this event. Off by default: the event has to opt in, the rule comes from trialPolicy, the event's category or the default rule.

    • can_sign_up_for_main_eventboolean

      Participants may sign up for the main event.

    • only_sign_up_for_main_eventboolean

      Participants may only sign up for the main event, not for sub-events.

    • sign_up_limit_days_beforeinteger

      Number of days before the start until which sign-ups are possible.

    • sign_up_limit_stop_days_beforeinteger

      Number of days before the start from which sign-ups are closed.

    • sign_up_delete_hours_beforeinteger

      Hours before the start until which a participant can cancel the sign-up.

    • start_timestring (date-time)

      Start of the event.

    • end_timestring (date-time)

      End of the event.

    • require_addressboolean

      Participants must enter an address when signing up.

    • require_contactboolean

      Participants must enter contact details when signing up.

    • require_billingboolean

      Participants must enter billing details when signing up.

    • allow_direct_billingboolean
    • require_direct_billingboolean
    • allow_budget_sign_upboolean
    • require_ageboolean

      Participants must enter their age when signing up.

    • require_grade_levelboolean

      Participants must enter their school grade level when signing up.

    • require_free_note_field_idsstring

      IDs of the free note fields that participants must fill in.

    • generate_new_bookingsboolean

      Bookings are generated automatically for the event schedule.

    • generate_new_bookings_v2boolean

      Bookings are generated with the second version of the schedule generator.

    • generate_ignore_sys_calendarboolean

      Generated bookings ignore the holidays of the system calendar.

    • copy_main_sign_ups_to_bookingboolean

      Sign-ups of the main event are copied to the generated bookings.

    • generate_hour_startstring (date-time)

      Start time of the day for generated bookings.

    • generate_hour_endstring (date-time)

      End time of the day for generated bookings.

    • generate_day_of_weekinteger

      Weekday for generated bookings.

    • bitmask_days_of_weekinteger

      This is a bitmask value of the days of the week the event occurs on

    • bitmask_hours_startinteger

      This is a bitmask value of the hours an event starts on

    • summarized_date_timesstring

      This is a string with the days and hours an event starts on

    • media_questionnaireMediaQuestionnaire2

      Questionnaire of the event in the media module.

    • customer_detail_ctastring

      Call-to-action text shown in the customer app on the event detail page.

    • customer_badgestring

      Badge text shown on the event in the customer app.

    • bib_number_modestring

      Vergabeart der Startnummern: OFF, MANUAL, AUTOMATIC oder BATCH. Greift nur, wenn der Event-Typ Startnummern hat (enableBibNumbers).

    • timing_gun_startstring (date-time)

      Startschuss; ohne Wert gilt startTime.

    • timing_rank_bystring

      Wertung nach Netto- (NET) oder Bruttozeit (GROSS).

    • timing_min_lap_secondsinteger

      Gleiche Person am gleichen Messpunkt innerhalb dieser Sekunden = Duplikat.

    • timing_public_liveboolean

      Live timing results are public.

    • timing_gps_trackingboolean

      GPS tracking of participants is enabled for timing.

    • timing_self_check_inboolean

      Participants can check in themselves for timing.

    • scoreboard_enabledboolean

      Scoreboard (Spielstand und Spielbericht) fuer das Event; die Eintraege sind EventScoreboardActivity, der Spielstand wird daraus berechnet.

    • scoreboard_sportstring

      Sportart des Scoreboards (ScoreboardSportRules), bestimmt die moeglichen Eintraege.

    • scoreboard_home_namestring

      Name of the home team on the scoreboard.

    • scoreboard_away_namestring

      Name of the away team on the scoreboard.

    • ticket_sales_enabledboolean

      Ticketverkauf statt Anmeldung: Teilnehmer kaufen Tickets (Ticketarten = Event-Preise mit Kontingent und Verkaufszeitraum), jedes Ticket bekommt einen Code für den Check-in. Greift nur mit der Einstellung event_ticket_sales_enabled.

    • ticket_max_per_orderinteger

      Höchstzahl Tickets je Bestellung; ohne Wert gilt event_ticket_max_per_order_default.

    • ticket_personalizedboolean

      Personalisierte Tickets: jedes Ticket braucht den Namen des Teilnehmers. Sonst laufen alle Tickets einer Bestellung auf den Namen des Käufers.

    • ticket_seatingboolean

      Platzwahl beim Ticketverkauf: jedes Ticket bekommt einen freien Platz aus dem Saalplan des Raums (BaseBookable::ticketSeatingPlan); die Ticketart kann auf eine Zone (ticketSeatZone) beschränkt sein. Greift nur mit der Einstellung event_ticket_seating_enabled.

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

    • … 20 more fields
  • ai_chat_promptstring

    The system prompt for the AI bot. The prompt will be suffixed by the MediaQuestionnaireContent in entries to give the AI a context of what questions we would like answers to at the end of the chat. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_optimizer_promptstring

    The system prompt for the AI bot. The prompt will be used to optimize the chat prompt with existing context. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_auto_close_secret_wordstring

    A word as the last part of an AI chat reply that will close the chat and trigger a completion of the questionnaire. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_chat_completed_promptstring

    The system prompt for the AI bot that takes all chat messages and the MediaQuestionnaireContent in entries to generate an answer to each of the questions. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • ai_answer_summary_promptstring

    The system prompt for the AI bot that takes the answer to each question and generates a summary / wiki article of the answers. Can be used with questionnaire type Q_TYPE_RESULT_LIST_AI_CHAT.

  • required_previous_questionnaireMediaQuestionnaire2

    Questionnaire that must be answered first.

  • group_allowedboolean

    Whether the questionnaire is limited to a group.

  • allow_self_registerboolean

    Whether people can register themselves to answer the questionnaire.

  • result_templateFlexibleLatexTemplate

    Template used to render the result of the questionnaire.

    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.

  • auto_send_result_templateboolean

    Whether the result is sent automatically after an answer is given.

  • allow_self_download_result_templateboolean

    Whether answerers can download their own result.

  • answer_productPredefinedBillingItem14

    Product used for billing individual questionnaire answers

    Show fields (15)
    • idinteger

      Primary key of the mapped billing item. Internal ID.

    • namestringrequired

      Name of the billing item.

    • descriptionstringrequired

      Description of the billing item shown to the customer.

    • internal_descriptionstring

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

    • fixed_hoursnumber (float)

      Fixed number of hours billed.

    • fixed_pricenumber (float)

      Fixed price billed.

    • fixed_price_base_unitnumber (float)

      Base unit for the fixed price.

    • price_fixed_hoursnumber (float)

      Price for the fixed hours.

    • price_additional_hoursnumber (float)

      Price for each additional hour.

    • name_additional_hoursstring

      Name of the additional hours item.

    • description_additional_hoursstring

      Description of the additional hours item.

    • time_billed_on_ticket_closeboolean

      Whether the time is billed when the ticket is closed.

    • billing_typeBillingItemType

      Billing item type.

    • buying_pricenumber (float)

      Purchase price of the item.

    • … 73 more fields
  • … 15 more fields
Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/media/questionnaire/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "show_free_text": true,
  "notification_email": "lena.hartmann@example.org",
  "notification_text": "Text",
  "notification_long_text": "Text",
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string"
}

Deletes a single MediaQuestionnaire

DELETE/api/media/questionnaire/{identifier}

Path parameters

identifierrequiredstring

Responses

200Deletes a single MediaQuestionnaireMediaQuestionnaire

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.

Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/media/questionnaire/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "show_free_text": true,
  "image_url": "https://vynst.de",
  "name": "Beispiel",
  "questionnaire_type": "string",
  "token": "string",
  "public_copyright": "string",
  "public_language_code": "string",
  "complexity_level": 1,
  "public_author": "string"
}

Get statistics for a MediaQuestionnaire with optional filtering.

GET/api/media/questionnaire/{identifier}/statistics

When filters are applied, includes comparison with unfiltered results.

Supported filter parameters:

  • minAge: Minimum age
  • maxAge: Maximum age
  • gender: Gender filter (M, W, D, U)
  • gradeLevel: Grade level
  • schoolClass: School class
  • naceSection: NACE section code (A-U)
  • naceCode: NACE code (e.g., 01.11, 62.01)
  • mediaQuestionnaireAnswerGroup: Filter to answers from specific group

Path parameters

identifierrequiredstring

Responses

default

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