Skip to content
Developer

MediaQuestionnaire Answer

Media22 EndpointsMedia / MediaQuestionnaire Answer

This method will get all MediaQuestionnaireAnswer Objects

GET/api/media/questionnaire_answer

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

Show fields (47)
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • genderstring

    Gender of the participant.

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • 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

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "company_name": "Beispiel",
    "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"
  }
]

Add a new MediaQuestionnaireAnswer

POST/api/media/questionnaire_answer

Responses

200Add a new MediaQuestionnaireAnswerMediaQuestionnaireAnswer2

Show fields (21)
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • answersarray<MediaQuestionnaireContentAnswer>

    Answers to the content of the questionnaire.

    Show fields (15)
    • idinteger

      Primary key of the content answer. Internal ID.

    • contentstring

      Text of the answer.

    • content_keystring

      Stable key of the answered question (MediaQuestionnaireContent::$contentKey)

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

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • confirmed_disclaimerboolean

    Disclaimer confirmed.

  • confirmed_privacyboolean

    Privacy policy confirmed.

  • confirmed_cancellation_policyboolean

    Cancellation policy confirmed.

  • attachmentsarray<Attachment10>

    Files attached to the answer.

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

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

    • … 2 more fields
  • … 36 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}

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

GET/api/media/questionnaire_answer/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single MediaQuestionnaireAnswerMediaQuestionnaireAnswer3

Show fields (6)
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • media_questionnaireMediaQuestionnaire5

    Questionnaire that was answered.

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

    • configuration_hintsarray<string>

      Not persisted: warnings about the installation setup this questionnaire depends on (e.g. AI comparison without LLM or OCR), filled for the admin detail response.

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

    • entriesarray<MediaQuestionnaireContent2>

      Questions and contents 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.

  • media_questionnaire_answer_groupMediaQuestionnaireAnswerGroup11

    Answer group the answer belongs to.

    Show fields (17)
    • answer_countinteger
    • companyCRMCompany23
    • personCRMPerson10
    • idinteger

      Primary key of the questionnaire answer group. Internal ID.

    • media_questionnaireMediaQuestionnaire5

      Questionnaire the answers belong to.

    • answersarray<MediaQuestionnaireAnswer3>

      Answers of the group.

    • end_timestring (date-time)

      Time the answers were completed.

    • confirmedboolean

      The answers are confirmed.

    • draftboolean

      The answers are a draft and not yet submitted.

    • processingboolean

      The answers are being processed.

    • externalboolean

      The answers were given by an external party.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • … 16 more fields
  • … 59 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}

Update a MediaQuestionnaireAnswer

PUT/api/media/questionnaire_answer/{identifier}

Path parameters

identifierrequiredstring

Responses

200Update a MediaQuestionnaireAnswerMediaQuestionnaireAnswer3

Show fields (6)
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • media_questionnaireMediaQuestionnaire5

    Questionnaire that was answered.

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

    • configuration_hintsarray<string>

      Not persisted: warnings about the installation setup this questionnaire depends on (e.g. AI comparison without LLM or OCR), filled for the admin detail response.

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

    • entriesarray<MediaQuestionnaireContent2>

      Questions and contents 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.

  • media_questionnaire_answer_groupMediaQuestionnaireAnswerGroup11

    Answer group the answer belongs to.

    Show fields (17)
    • answer_countinteger
    • companyCRMCompany23
    • personCRMPerson10
    • idinteger

      Primary key of the questionnaire answer group. Internal ID.

    • media_questionnaireMediaQuestionnaire5

      Questionnaire the answers belong to.

    • answersarray<MediaQuestionnaireAnswer3>

      Answers of the group.

    • end_timestring (date-time)

      Time the answers were completed.

    • confirmedboolean

      The answers are confirmed.

    • draftboolean

      The answers are a draft and not yet submitted.

    • processingboolean

      The answers are being processed.

    • externalboolean

      The answers were given by an external party.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • … 16 more fields
  • … 59 more fields
Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}

Update a MediaQuestionnaireAnswer

PATCH/api/media/questionnaire_answer/{identifier}

Path parameters

identifierrequiredstring

Responses

200Update a MediaQuestionnaireAnswerMediaQuestionnaireAnswer3

Show fields (6)
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • media_questionnaireMediaQuestionnaire5

    Questionnaire that was answered.

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

    • configuration_hintsarray<string>

      Not persisted: warnings about the installation setup this questionnaire depends on (e.g. AI comparison without LLM or OCR), filled for the admin detail response.

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

    • entriesarray<MediaQuestionnaireContent2>

      Questions and contents 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.

  • media_questionnaire_answer_groupMediaQuestionnaireAnswerGroup11

    Answer group the answer belongs to.

    Show fields (17)
    • answer_countinteger
    • companyCRMCompany23
    • personCRMPerson10
    • idinteger

      Primary key of the questionnaire answer group. Internal ID.

    • media_questionnaireMediaQuestionnaire5

      Questionnaire the answers belong to.

    • answersarray<MediaQuestionnaireAnswer3>

      Answers of the group.

    • end_timestring (date-time)

      Time the answers were completed.

    • confirmedboolean

      The answers are confirmed.

    • draftboolean

      The answers are a draft and not yet submitted.

    • processingboolean

      The answers are being processed.

    • externalboolean

      The answers were given by an external party.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • … 16 more fields
  • … 59 more fields
Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}

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

DELETE/api/media/questionnaire_answer/{identifier}

Path parameters

identifierrequiredstring

Responses

200Deletes a single MediaQuestionnaireAnswerMediaQuestionnaireAnswer11

Show fields (45)
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • genderstring

    Gender of the participant.

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • addressstring

    Address as text.

  • address_streetstring

    Street of the address.

  • address_house_numberstring

    House number of the address.

  • address_street_levelstring

    Street and house number of the address.

  • address_costring

    Care-of line of the address.

  • address_citystring

    City of the address.

  • address_zipstring

    Postal code of the address.

  • 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

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "company_name": "Beispiel",
  "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"
}

This method will get all MediaQuestionnaireAnswer Objects for customer

GET/api/media/customer/questionnaire_answer

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 MediaQuestionnaireAnswer objects for customerarray<MediaQuestionnaireAnswer5>

Show fields (30)
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • attachmentsarray<Attachment12>

    Files attached to the answer.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • namestring

    Name of the entity.

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/customer/questionnaire_answer \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "company_name": "Beispiel",
    "name": "Beispiel",
    "gender": "string",
    "confirmed": true,
    "draft": true,
    "processing": true,
    "external": true
  }
]

Add a new MediaQuestionnaireAnswer as customer

POST/api/media/customer/questionnaire_answer

Responses

200Add a new MediaQuestionnaireAnswer as customerMediaQuestionnaireAnswer5

Show fields (30)
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • attachmentsarray<Attachment12>

    Files attached to the answer.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • namestring

    Name of the entity.

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/customer/questionnaire_answer \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "name": "Beispiel",
  "gender": "string",
  "confirmed": true,
  "draft": true,
  "processing": true,
  "external": true
}

Add a new MediaQuestionnaireAnswer draft as customer

POST/api/media/customer/questionnaire_answer_draft

Responses

200Add a new MediaQuestionnaireAnswer draft as customerMediaQuestionnaireAnswer7

Show fields (29)
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • tokenstring

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

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • attachmentsarray<Attachment12>

    Files attached to the answer.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • namestring

    Name of the entity.

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/customer/questionnaire_answer_draft \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "name": "Beispiel",
  "gender": "string",
  "token": "string",
  "confirmed": true,
  "draft": true,
  "processing": true
}

Update MediaQuestionnaireAnswer draft as customer

PUT/api/media/customer/questionnaire_answer_draft/{identifier}

Path parameters

identifierrequiredstring

Responses

200Update MediaQuestionnaireAnswer draft as customerMediaQuestionnaireAnswer7

Show fields (29)
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • tokenstring

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

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • attachmentsarray<Attachment12>

    Files attached to the answer.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • namestring

    Name of the entity.

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/media/customer/questionnaire_answer_draft/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "name": "Beispiel",
  "gender": "string",
  "token": "string",
  "confirmed": true,
  "draft": true,
  "processing": true
}

Add a new MediaQuestionnaireAnswer for questionnaire as a guest

POST/api/media/public/questionnaire_answer

Request body application/json

  • dataMediaQuestionnaireAnswer8
    Show fields (37)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • confirmedboolean

      The answer is confirmed.

    • draftboolean

      The answer is a draft and not yet submitted.

    • processingboolean

      The answer is being processed.

    • externalboolean

      The answer was given by an external party.

    • birthdaystring (date-time)

      Birthday of the participant.

    • known_allergiesstring

      Known allergies of the participant.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • grade_levelinteger

      School grade level of the participant.

    • school_classstring

      School class of the participant.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • attachmentsarray<Attachment12>

      Files attached to the answer.

    • report_notesstring

      Additions of the auditor to the report (result template), e.g. a summary written after the review

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • role_in_companystring

      Role/position of the respondent in the company

    • start_in_companystring

      When the respondent started working at the company

    • company_namestring

      When the respondent started working at the company

    • answer_durationinteger

      Duration in seconds the respondent took to complete the questionnaire

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

Responses

200Add a new MediaQuestionnaireAnswer for questionnaire as a guestMediaQuestionnaireAnswer9

Show fields (28)
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • attachmentsarray<Attachment12>

    Files attached to the answer.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • namestring

    Name of the entity.

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/public/questionnaire_answer \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "company_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "name": "Beispiel",
  "gender": "string",
  "confirmed": true,
  "draft": true,
  "processing": true,
  "external": true
}

Add a new MediaQuestionnaireAnswer draft for questionnaire as a guest

POST/api/media/public/questionnaire_answer_draft

Request body application/json

  • dataMediaQuestionnaireAnswer8
    Show fields (37)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • confirmedboolean

      The answer is confirmed.

    • draftboolean

      The answer is a draft and not yet submitted.

    • processingboolean

      The answer is being processed.

    • externalboolean

      The answer was given by an external party.

    • birthdaystring (date-time)

      Birthday of the participant.

    • known_allergiesstring

      Known allergies of the participant.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • grade_levelinteger

      School grade level of the participant.

    • school_classstring

      School class of the participant.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • attachmentsarray<Attachment12>

      Files attached to the answer.

    • report_notesstring

      Additions of the auditor to the report (result template), e.g. a summary written after the review

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • role_in_companystring

      Role/position of the respondent in the company

    • start_in_companystring

      When the respondent started working at the company

    • company_namestring

      When the respondent started working at the company

    • answer_durationinteger

      Duration in seconds the respondent took to complete the questionnaire

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

Responses

200Add a new MediaQuestionnaireAnswer draft for questionnaire as a guestMediaQuestionnaireAnswer9

Show fields (28)
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • attachmentsarray<Attachment12>

    Files attached to the answer.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • namestring

    Name of the entity.

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/public/questionnaire_answer_draft \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "company_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "name": "Beispiel",
  "gender": "string",
  "confirmed": true,
  "draft": true,
  "processing": true,
  "external": true
}

Update MediaQuestionnaireAnswer draft for questionnaire as a guest

PUT/api/media/public/questionnaire_answer_draft/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataMediaQuestionnaireAnswer8
    Show fields (37)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • confirmedboolean

      The answer is confirmed.

    • draftboolean

      The answer is a draft and not yet submitted.

    • processingboolean

      The answer is being processed.

    • externalboolean

      The answer was given by an external party.

    • birthdaystring (date-time)

      Birthday of the participant.

    • known_allergiesstring

      Known allergies of the participant.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • grade_levelinteger

      School grade level of the participant.

    • school_classstring

      School class of the participant.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • attachmentsarray<Attachment12>

      Files attached to the answer.

    • report_notesstring

      Additions of the auditor to the report (result template), e.g. a summary written after the review

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • role_in_companystring

      Role/position of the respondent in the company

    • start_in_companystring

      When the respondent started working at the company

    • company_namestring

      When the respondent started working at the company

    • answer_durationinteger

      Duration in seconds the respondent took to complete the questionnaire

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

Responses

200Update MediaQuestionnaireAnswer draft for questionnaire as a guestMediaQuestionnaireAnswer9

Show fields (28)
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • first_namestring

    First name of the participant.

  • last_namestring

    Last name of the participant.

  • genderstring

    Gender of the participant.

  • confirmedboolean

    The answer is confirmed.

  • draftboolean

    The answer is a draft and not yet submitted.

  • processingboolean

    The answer is being processed.

  • externalboolean

    The answer was given by an external party.

  • birthdaystring (date-time)

    Birthday of the participant.

  • known_allergiesstring

    Known allergies of the participant.

  • confirmed_no_allergiesboolean

    Guardian confirmed that there are no known allergies.

  • grade_levelinteger

    School grade level of the participant.

  • school_classstring

    School class of the participant.

  • attachmentsarray<Attachment12>

    Files attached to the answer.

  • review_statusstring

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

  • nace_sectionstring

    NACE section code (letter A-U)

  • nace_codestring

    NACE code (numeric like 01.11, 62.01)

  • role_in_companystring

    Role/position of the respondent in the company

  • start_in_companystring

    When the respondent started working at the company

  • company_namestring

    When the respondent started working at the company

  • answer_durationinteger

    Duration in seconds the respondent took to complete the questionnaire

  • billedboolean

    The answer was billed.

  • namestring

    Name of the entity.

  • company_employee_countinteger

    Number of employees of the company.

  • company_founding_yearinteger

    Founding year of the company.

  • company_family_ownedboolean

    Whether the company is family-owned.

  • company_sales_volumestring

    Sales volume of the company.

  • company_segmentstring

    Market segment of the company.

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/media/public/questionnaire_answer_draft/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "company_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  }
}
'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "name": "Beispiel",
  "gender": "string",
  "confirmed": true,
  "draft": true,
  "processing": true,
  "external": true
}

Test adding a new MediaQuestionnaireAnswer as customer / public

POST/api/media/public/test_questionnaire_answer

Request body application/json

  • dataMediaQuestionnaireAnswer8
    Show fields (37)
    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • confirmedboolean

      The answer is confirmed.

    • draftboolean

      The answer is a draft and not yet submitted.

    • processingboolean

      The answer is being processed.

    • externalboolean

      The answer was given by an external party.

    • birthdaystring (date-time)

      Birthday of the participant.

    • known_allergiesstring

      Known allergies of the participant.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • grade_levelinteger

      School grade level of the participant.

    • school_classstring

      School class of the participant.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • attachmentsarray<Attachment12>

      Files attached to the answer.

    • report_notesstring

      Additions of the auditor to the report (result template), e.g. a summary written after the review

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • role_in_companystring

      Role/position of the respondent in the company

    • start_in_companystring

      When the respondent started working at the company

    • company_namestring

      When the respondent started working at the company

    • answer_durationinteger

      Duration in seconds the respondent took to complete the questionnaire

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

Responses

200Test adding a new MediaQuestionnaireAnswer as customer / publicMediaQuestionnaireAnswerTest

Show fields (6)
  • answer_allowedboolean

    Whether answering is allowed.

  • answer_delete_allowedboolean

    Whether an answer may be deleted.

  • answer_explicitly_disabledboolean

    Whether answering is explicitly disabled.

  • answer_require_add_bank_accountboolean

    Whether answering requires a bank account to be added first.

  • answer_requires_loginboolean

    Whether answering requires a login.

  • answer_require_add_access_tagboolean

    Whether an access tag must be added before answering.

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/public/test_questionnaire_answer \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "first_name": "Lena",
    "last_name": "Hartmann",
    "company_name": "Beispiel",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  }
}
'
Response 200 application/json
{
  "answer_allowed": true,
  "answer_delete_allowed": true,
  "answer_explicitly_disabled": true,
  "answer_require_add_bank_account": true,
  "answer_requires_login": true,
  "answer_require_add_access_tag": true
}

Add an Attachment to a draft MediaQuestionnaireAnswer as a guest (token based)

POST/api/media/public/questionnaire_answer/{identifier}/adds/attachments

Path parameters

identifierrequiredstring

Responses

default

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/public/questionnaire_answer/42/adds/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'

Remove an Attachment from a draft MediaQuestionnaireAnswer as a guest (token based)

POST/api/media/public/questionnaire_answer/{identifier}/deletes/attachments

Path parameters

identifierrequiredstring

Responses

default

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/public/questionnaire_answer/42/deletes/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'

Add an Attachment to a MediaQuestionnaireAnswer

POST/api/media/questionnaire_answer/{identifier}/adds/attachments

Path parameters

identifierrequiredstring

Responses

200Add an Attachment to a MediaQuestionnaireAnswerMediaQuestionnaireAnswer10

Show fields (6)
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • media_questionnaireMediaQuestionnaire5

    Questionnaire that was answered.

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

    • configuration_hintsarray<string>

      Not persisted: warnings about the installation setup this questionnaire depends on (e.g. AI comparison without LLM or OCR), filled for the admin detail response.

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

    • entriesarray<MediaQuestionnaireContent2>

      Questions and contents 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.

  • media_questionnaire_answer_groupMediaQuestionnaireAnswerGroup12

    Answer group the answer belongs to.

    Show fields (17)
    • answer_countinteger
    • companyCRMCompany23
    • personCRMPerson10
    • idinteger

      Primary key of the questionnaire answer group. Internal ID.

    • media_questionnaireMediaQuestionnaire5

      Questionnaire the answers belong to.

    • answersarray<MediaQuestionnaireAnswer10>

      Answers of the group.

    • end_timestring (date-time)

      Time the answers were completed.

    • confirmedboolean

      The answers are confirmed.

    • draftboolean

      The answers are a draft and not yet submitted.

    • processingboolean

      The answers are being processed.

    • externalboolean

      The answers were given by an external party.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • … 16 more fields
  • … 59 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer/42/adds/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}

Remove an Attachment from Ticket

POST/api/media/questionnaire_answer/{identifier}/deletes/attachments

Path parameters

identifierrequiredstring

Responses

200Remove an Attachment from MediaQuestionnaireAnswerMediaQuestionnaireAnswer10

Show fields (6)
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • media_questionnaireMediaQuestionnaire5

    Questionnaire that was answered.

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

    • configuration_hintsarray<string>

      Not persisted: warnings about the installation setup this questionnaire depends on (e.g. AI comparison without LLM or OCR), filled for the admin detail response.

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

    • entriesarray<MediaQuestionnaireContent2>

      Questions and contents 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.

  • media_questionnaire_answer_groupMediaQuestionnaireAnswerGroup12

    Answer group the answer belongs to.

    Show fields (17)
    • answer_countinteger
    • companyCRMCompany23
    • personCRMPerson10
    • idinteger

      Primary key of the questionnaire answer group. Internal ID.

    • media_questionnaireMediaQuestionnaire5

      Questionnaire the answers belong to.

    • answersarray<MediaQuestionnaireAnswer10>

      Answers of the group.

    • end_timestring (date-time)

      Time the answers were completed.

    • confirmedboolean

      The answers are confirmed.

    • draftboolean

      The answers are a draft and not yet submitted.

    • processingboolean

      The answers are being processed.

    • externalboolean

      The answers were given by an external party.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • … 16 more fields
  • … 59 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer/42/deletes/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}

Get PDF for a MediaQuestionnaireAnswer using the questionnaire's result template

GET/api/media/questionnaire_answer/{identifier}/pdf

Path parameters

identifierrequiredstring

Responses

default

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

Get the AI comparison of a MediaQuestionnaireAnswer as Excel file: one row per answered question with the answer, the AI comparison prompt and the AI result

GET/api/media/questionnaire_answer/{identifier}/ai_comparison_xlsx

Path parameters

identifierrequiredstring

Responses

default

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

Create a new MediaQuestionnaireAnswerGroup from an existing single answer

POST/api/media/questionnaire_answer/{identifier}/create_group

Path parameters

identifierrequiredstring

Responses

200Create a new group from a single answerMediaQuestionnaireAnswerGroup

Show fields (6)
  • answer_countinteger
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer group. Internal ID.

  • answersarray<MediaQuestionnaireAnswer2>

    Answers of the group.

    Show fields (54)
    • companyCRMCompany23
    • personCRMPerson10
    • idinteger

      Primary key of the questionnaire answer. Internal ID.

    • answersarray<MediaQuestionnaireContentAnswer>

      Answers to the content of the questionnaire.

    • first_namestring

      First name of the participant.

    • last_namestring

      Last name of the participant.

    • genderstring

      Gender of the participant.

    • confirmedboolean

      The answer is confirmed.

    • draftboolean

      The answer is a draft and not yet submitted.

    • processingboolean

      The answer is being processed.

    • externalboolean

      The answer was given by an external party.

    • birthdaystring (date-time)

      Birthday of the participant.

    • known_allergiesstring

      Known allergies of the participant.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • grade_levelinteger

      School grade level of the participant.

    • school_classstring

      School class of the participant.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • attachmentsarray<Attachment10>

      Files attached to the answer.

    • event_sign_upBaseEventSignUp19

      Event sign-up the answer belongs to.

    • secondary_event_sign_upBaseEventSignUp19

      Second event sign-up the answer belongs to.

    • review_statusstring

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

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • role_in_companystring

      Role/position of the respondent in the company

    • start_in_companystring

      When the respondent started working at the company

    • company_namestring

      When the respondent started working at the company

    • answer_durationinteger

      Duration in seconds the respondent took to complete the questionnaire

    • billedboolean

      The answer was billed.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • 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

    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • … 3 more fields
  • … 25 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer/42/create_group \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "company_name": "Beispiel",
  "name": "Beispiel",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "answer_count": 1,
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "profile_picture_url": "https://vynst.de",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "answers": [
    {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "company_name": "Beispiel",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "name": "Beispiel"
    }
  ],
  "end_time": "2026-10-15T09:30:00+02:00"
}

Restart the AI processing (AI comparison or AI chat evaluation) of a submitted MediaQuestionnaireAnswer

POST/api/media/questionnaire_answer/{identifier}/reprocess_ai

Path parameters

identifierrequiredstring

Responses

200Restart the AI processing of a MediaQuestionnaireAnswerMediaQuestionnaireAnswer3

Show fields (6)
  • companyCRMCompany23
    Show fields (62)
    • idinteger

      Primary key of the company. Internal ID.

    • short_namestring

      Short name of the company.

    • company_namestring

      Legal name of the company.

    • secondary_namestring

      Second name line of the company.

    • direct_dialstring

      Direct dial number of the company.

    • invoice_emailstring

      E-mail address for invoices.

    • send_invoice_emailboolean

      Send invoices by e-mail.

    • send_invoice_letterboolean

      Send invoices by letter.

    • time_report_emailstring

      E-mail address for time reports.

    • payment_goalPaymentGoal

      Payment term of the company.

    • payment_intervalstring

      Interval of the payments.

    • vatidstring

      VAT identification number.

    • taxnumberstring

      Tax number of the company.

    • buyer_reference_idstring

      Leitweg-ID or custom reference ID defined by the customer

    • taxTax

      Tax rate used for the company.

    • infostring

      Information about the company.

    • numberstring

      Customer or supplier number of the company.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Company number as text, including prefix.

    • is_customerboolean

      The company is a customer.

    • is_supplierboolean

      The company is a supplier.

    • is_otherboolean

      The company is neither customer nor supplier.

    • is_memberboolean

      The company is a member.

    • archivedboolean

      The company is archived.

    • categoryCRMCompanyCategory

      Category of the company.

    • visible_for_customerboolean

      Whether the company is visible to the customer.

    • founding_datestring (date-time)

      Founding date of the company.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

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

    • payment_typePaymentType
    • company_employee_countinteger

      Number of employees of the company.

    • company_founding_yearinteger

      Founding year of the company.

    • company_family_ownedboolean

      Whether the company is family-owned.

    • company_sales_volumestring

      Sales volume of the company.

    • company_segmentstring

      Market segment of the company.

  • personCRMPerson10
    Show fields (81)
    • idinteger

      Primary key of the person. Internal ID.

    • first_namestring

      First name of the person.

    • last_namestring

      Last name of the person.

    • numberinteger

      Member or customer number of the person.

    • manual_numberinteger

      Number set manually instead of the automatic number.

    • number_stringstring

      Member or customer number as text, including prefix.

    • genderstring

      Gender of the person.

    • titlestring

      Academic or other title of the person.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • 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

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • idinteger

    Primary key of the questionnaire answer. Internal ID.

  • media_questionnaireMediaQuestionnaire5

    Questionnaire that was answered.

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

    • configuration_hintsarray<string>

      Not persisted: warnings about the installation setup this questionnaire depends on (e.g. AI comparison without LLM or OCR), filled for the admin detail response.

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

    • entriesarray<MediaQuestionnaireContent2>

      Questions and contents 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.

  • media_questionnaire_answer_groupMediaQuestionnaireAnswerGroup11

    Answer group the answer belongs to.

    Show fields (17)
    • answer_countinteger
    • companyCRMCompany23
    • personCRMPerson10
    • idinteger

      Primary key of the questionnaire answer group. Internal ID.

    • media_questionnaireMediaQuestionnaire5

      Questionnaire the answers belong to.

    • answersarray<MediaQuestionnaireAnswer3>

      Answers of the group.

    • end_timestring (date-time)

      Time the answers were completed.

    • confirmedboolean

      The answers are confirmed.

    • draftboolean

      The answers are a draft and not yet submitted.

    • processingboolean

      The answers are being processed.

    • externalboolean

      The answers were given by an external party.

    • confirmed_disclaimerboolean

      Disclaimer confirmed.

    • confirmed_privacyboolean

      Privacy policy confirmed.

    • confirmed_cancellation_policyboolean

      Cancellation policy confirmed.

    • nace_sectionstring

      NACE section code (letter A-U)

    • nace_codestring

      NACE code (numeric like 01.11, 62.01)

    • … 16 more fields
  • … 59 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/questionnaire_answer/42/reprocess_ai \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "company_name": "Beispiel",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "name": "Beispiel"
}