Authentication header for requests; contains ticket or login/password. Developer: SOAP header element used for auth; required for authenticated operations. See Header type fields and CustomizingAPI_Base::Header Authentication header for requests; provide a ticket or login and password. Developer: Missing ticket/login yields ERR_107, invalid ticket ERR_105, invalid credentials ERR_103; maintenance mode/license/IP-restrictions/userrights can block requests A ticket-string, that can be acquired by the RequestTicket transaction. Ban be a substitute for Login and Password. Developer: Provide either Ticket or Login+Password; missing header yields ERR_104; missing ticket/login yields ERR_107 Login name of a service user configured in the system. Can be substituted with a ticket. Developer: Provide either Ticket or Login+Password; missing header yields ERR_104; missing ticket/login yields ERR_107 Password of the corresponding service user. Can be substituted with a ticket. Developer: Provide either Ticket or Login+Password; missing header yields ERR_104; missing ticket/login yields ERR_107 A list of integer values. Unless stated otherwise in the consuming operation, supply positive integers. Integer entry; use positive values unless documented otherwise. A list of strings; meaning depends on the consuming element (ids, names, emails, etc.). A list of string values. The expected format depends on the consuming element (e.g. names, ids, emails). String entry. A list of integer ids. Invalid (<=0) values are ignored by the server; a list containing only invalid values is treated as empty. A single integer value, representing an internal id - e.g. of a course or a subunit. Should be >0. A list of online survey keys objects which contain information about the survey and the course A list of online survey keys objects which contain information about the survey and the course A list of survey type objects which are used by the system to determine the type of surveys A single survey type. For valid values, look into the corresponding type. A list of email address objects which represent a valid email address A single email address. For valid values, look into the corresponding type. A list of survey participant objects which represent a participant who has taken part in a survey A single survey participant. For valid values, look into the corresponding type. A list of keys and values which have a connection to one another. Mostly used for configuration purposes, e.g. for a report or a survey. A single KeyValuePair. For valid values, look into the corresponding type. A list of course objects A single course. For valid values, look into the corresponding type. A list of user objects A single user. For valid values, look into the corresponding type. A list of person objects. A person represents a possible participant of a course or a survey A single person. For valid values, look into the corresponding type. A list of period objects. A single person. For valid values, look into the corresponding type. A list of forms, simplified to only basic information A single form. For valid values, look into the corresponding type. A list of surveys. A single survey. For valid values, look into the corresponding type. A list of subunit objects. A single subunit. For valid values, look into the corresponding type. A list of online codes, which might be used to participate in an online survey. A single online code. For valid values, look into the corresponding type. A list of course creator objects. A single course creator. For valid values, look into the corresponding type. A list of module survey creator objects. A single module survey creator. For valid values, look into the corresponding type. A list of survey creator objects. A single survey creator. For valid values, look into the corresponding type. A list of instructor objects. A single instructor. For valid values, look into the corresponding type. A list of modules. A single module. For valid values, look into the corresponding type. A list of module courses. A single module course. For valid values, look into the corresponding type. An object that represents a survey type. Is used for surveys and reports. A string that represents a survey type. Is always a single type digit. A string describes the survey type. e.g. Online Survey (pswd based) when the type is 'o' Password based online survey Codeword based online survey Paper based survey with serial printing Paper based survey with coversheet Hybrid based survey Subunit id selector: INTERNAL (numeric id), NAME (subunit name), EXTERNAL (third-party id). The internal id used by the system. The name of the subunit. If multiple subunits with the same name exist, the subunit with the lower internal id (the older) subunit is used. An optional id that can be given to a subunit, which represents mostly an id from a third party application. User id selector: INTERNAL (numeric id), LOGIN (username), EXTERNAL (third-party id). The internal id used by the system. The login name of the user. An optional id that can be given to a user, which represents mostly an id from a third party application. Form id selector: INTERNAL (numeric id) or FORMNAME (form name). The internal id used by the system. The name of the form. Course id selector: INTERNAL (numeric id), PUBLIC (public course id), EXTERNAL (third-party id). The internal id used by the system. The public course id. If more multiple courses with the same public course ids are present, the one with the lowest internal id (the oldest) is used. An optional id that can be given to a course, which represents mostly an id from a third party application. Period id selector: INTERNAL (numeric id), PERIODNAME (name), PERIODDATE (date within the period), INNER_ACTIVE_PERIOD_ON_DATE/OUTER_ACTIVE_PERIOD_ON_DATE (helper modes). The internal id used by the system. The name of the period that it has in the system A date that is within a valid period. If multiple periods are found within the system, which lie in the specified date, the period which the latest end date is chosen. A date that is within a valid period. If multiple periods are found within the system, which lie in the specified date, the period which the earliest start date is chosen. A date that is within a valid period. Shares the same behavior with PERIODDATE A string that determines the dual scale mode of scaled questions given in a request/response The dual scaled questions are classified according to the quality and the importance. They are displayed as profile lines in a report. The dual scaled questions are classified according to target-performance comparison. They are displayed in a report as a radar chart. The dual scaled questions are classified according to learning outcome. They are displayed in a report as outcome based evaluation. Field that specifies which data should be used when searching for a form Uses the form data for the search. Takes into account the form ID, description, and short text. Takes the form data into account during the search. Also uses the information from the question groups on the form. Uses the heading text for the search. Considers all data specified within the form. Additionally uses information from the question, namely the question texts. Uses all available information sources for the search. Combines all other FormSearchTypes. Behaves like Form. In Progress Data available Data deleted Data Count below minimalform count defined in the settings Data entry Verification Participant import necessary (Exam) Exam: Scoring (Exam) Enabled Reminded Disabled Finished Enabled (Predefined Optional Questions) Enabled (Outcome-based Evaluation) Reminded (Predefined Optional Questions) Reminded (Outcome-based Evaluation) Instructor Dean Administrator Dean of Studies Data entry assistant Report Creator Verifier Subunit Administator Module user SOAP/API User A pair of keys and values used by different transactions, mostly configuration based The key of the pair. In configuration based transactions usually the name of the configuration. The value of the pair. In configuration based transactions usually the value of the configuration. May be empty/null. Represents an email with all necessary data. Which e-mail address is the sender of this e-mail? Must contain a valid e-mail address. Who is the sender of this e-mail. Can contain up to 255 characters. Who are the recipients of this e-mail. Should only contain a list of valid e-mail addresseses, or the mail might not be sent. Subject of the Mail. Should not contain HTML. Body/Text of the Mail. Can contain HTML. Delivery type enum: 0=UNKNOWN, 1=REPORT, 2=COVERSHEET, 3=FORM, 4=COVERSHEET_FORM, 5=REPORT_REGULARTIVE, 6=PROFILE_CREATED, 7=IOQ_ACTIVATED, 8=IOQ_REMINDED, 9=IOQ_DEACTIVATED, 10=MUTLI_PROFILE_LINE, 11=REPORT_DEFINITION, 12=PSWD_DISPATCH, 13=HYBRID, 14=PSWD_DISPATCH_STUDENT, 15=PSWD_DISPATCH_STUDENT_REMINDER, 16=UTIL_REPORT, 17=RAW_DATA_REPORT, 18=RESULT_INFO_PARTICIPANTS, 19=SUMMARY_REPORT, 20=ARCHIVE_REPORT, 21=QM_REPORT, 22=QM_DEFINED_QUALITY, 23=RESPONSE_RATE, 24=PSWD_DISPATCH_STUDENT_MERGED, 25=PSWD_DISPATCH_STUDENT_REMINDER_MERGED, 26=PARTICIPANT_REPORT, 27=NOTIFY_SURVEY_START, 28=ONLINE_CODE_DISPATCH_STUDENT, 29=ONLINE_CODE_DISPATCH_STUDENT_REMINDER, 30=API, 31=RESULTS_TO_PARTICIPANTS. Who are the recipients of this e-mail in the CC field. Should only contain a list of valid e-mail addresses, or the mail might not be sent. Who are the recipients of this e-mail as background recipients (BCC field). Should only contain a list of valid e-mail addresses, or the mail might not be sent. Optional scheduled send date/time (use ISO-8601). Status code for the mail (backend-specific int). Related survey id (>0) if applicable. Creation timestamp (string, ISO-8601 recommended). Mail id (>0) when persisted. Error messages/codes if sending failed. Paths to attachments to include. Collection of mails to be queued/sent. A single mail. For valid values, look into the corresponding type. List of email addresses (strings). Each entry should be a valid email address. Email address entry. Email address string; must match the provided regex pattern (basic validation). service fault structure containing code, description and detail. Fault code (ERR_*). Human readable message. Details string, may contain placeholders resolved by server. Fault payload for failed requests. Developer: Used in SoapfaultMessage parts Text alignment enum: right, left, center, justify, or empty for default. Online layout identifier (string enum configured in backend). Form item/question definition; ids >0 when persisted. Many properties are optional depending on question type. Item id (>0) if persisted. Position within group; non-negative. Item title/question text. Item code/identifier. Expected answer count; non-negative when set. Question type enum. Answer options (as strings) for choice-based items. Preferred graph type for reporting (string enum); Valid Values: 'STANDARD', 'ICR_NUM_BARCHART', 'ICR_NUM_BARCHART_GROUP_10', 'HISTO', 'PIE', 'DONUT', 'COLORHISTO', 'STACKEDBAR'. Should be set within the UI, not via API Request as some of the display types are dependent on system settings. Default is 'STANDARD'. Abstention label. Layout orientation (horizontal/vertical). Row count for matrix/open fields; non-negative. True if question is mirrored when displayed. ICR usage flag (string, evaluated as bool). ICR type id (int enum) if ICR enabled. Valid values: 0: No ICR, 1: normal ICR, 2: segmented ICR ICR classifier string if required. Use a combination of valid classifiers to determine your IRC pattern. Valid Values: N: Number, L: Letter, A: Number or Letter. Option Value of a question. Answer position on paper based forms. Only applies to single choice questions. Valid Values: 'null': take form layout, 0: next to the question text, 1: below question text. Display options as dropdown in online based survey if true. Only applies to single choice questions. Maximum of checked answers allowed for an online based multiple choice question; non-negative. 'null' equals 'no limit'. Alignment for rendering. Degree for displaying a scale; non-negative. True if answer is required. Item id of another scaled question (>0) for dual scaled questions. Position index for dual scale (first part or second part); non-negative. Export values per option (ints), aligns with Options. Option indexes (ints) when custom ordering is used. Additional options/config as serialized string. List of items (questions/content blocks) in a group or form. List of items (questions/content blocks) in this group or form. Scaled Question Open Question Grade Question Single Choice Question Multiple Choice Question Extended Single Choice Question Matrix Question Pole Definition Empty Line Separator Line Text Section Page Break Extended Pole Definition Image Column Separator Paragraph Separator Group of items in a form; ids >0 when persisted, positions non-negative. Group id (>0). Display position on form; non-negative. Group title. Group description text. Optional indicator dimension id. Can be between 0: no indicator 2: indicator of 2-options scaled questions and 11: indicator of 11-options scaled question. True if the group contains only text. Font size for text; non-negative. Dual scale mode setting if applicable. Items contained in the group. List of item groups in a form. A single item group. For valid values, look into the corresponding type. Item group in a module context; similar to ItemGroup but keyed by session UID. Display position on a form; non-negative. Group title. Session UID linking this group to a module course. Group description. Optional indicator dimension id. Can be between 0: no indicator 2: indicator of 2-options scaled questions and 11: indicator of 11-options scaled question. True if group contains only text. Font size; non-negative. Dual scale mode setting. Items contained. List of module item groups (module-specific grouping of items). A single module item group. For valid values, look into the corresponding type. List of VividForms form definitions. A single form definition. For valid values, look into the corresponding type. Full form definition (VividForms). IDs >0 when present; sizes/counts are non-negative; dates are strings (use ISO-8601 when writing). Form id (>0) if persisted. Form short name. Between 4 and 25 Characters. Form title/long name. Owner user id (>0) if set. True if all scaled questions on this form should be displayed mirrored. Paper format for paper based surveys. Valid value: 'A4', 'Letter', 'Legal'. Show item numeration if true. Answer box size (pixels/units; non-negative). Maximum pages; non-negative. Maximum questions; non-negative. Font family. Font size; non-negative. Row height; non-negative. Creation date/time (string, ISO-8601 recommended). Is automatically filled. Activated flag - is this form enabled and can be used to generate surveys.. True if optional questions/extensions are allowed. Allow result access for participants after evaluation with this form. Can be overwritten in the survey. Header text upper left. Header text lower left. Header text upper right. Header text lower right. Header mark text. Header correction text. List of item groups in the form. Number of header lines (0-8). Additional header lines (up to 8). Layout used for online rendering. Folder name/path for the form. Last change timestamp (string, ISO-8601). Automatically changed by the system. Default report id (>0) if set. Number of previous periods to compare, e.g. for profile line reporting; non-negative. Optional header line with left/right text fields for printed/exported forms. Left-aligned text content. Right-aligned text content. Container for additional header lines (max 8 entries). Header lines; up to eight entries allowed. Form procedure scope. Form can be used for all evaluations. Form can only be used for central evaluation. Form can only be used for decentral evaluation. Survey type availability for forms. Form can be used for all kinds of survey. Form can be used for paper based surveys only. Form can be used for online based surveys only. Properties used to update a form. Id must be coupled with IdType to resolve the target; flags adjust availability, extensibility and online behavior. Form identifier (interpreted via IdType). How to resolve FormId (internal id, name, etc.). Short name of the form. Long title/description. Activate/deactivate form for survey generation. Allow optional questions/extensions. Set result access for participants for this form. Can be overwritten in the survey. Allowed procedures. Survey type availability. Target folder name. Layout identifier for online surveys. Allow temporary save in online mode. Filter for form queries. User list is required; combine with search query, folder, status flags, limits, ordering and selected fields to reduce payload. User identifiers (id/login/external) used to scope forms. Free-text search across form names/descriptions. Include forms owned by other subunit admins. Order by column. Ascending(ASC) or Descending(DESC). Max rows to return; use positive values. Include deactivated forms if true. Exclude active forms if true. Include child/derived forms (Moduleforms, Forms with IOQs). Filter by folder id (>0). Limit returned columns to these fields. Search scope (e.g., own/shared/system). Selectable form field identifiers to shape query responses (column names from form metadata). List of form fields to include in responses. Field identifier to include in responses. Form summary for listings: id/original id, name, owner, engine, available custom reports and usage restrictions. Internal form id (>0 when present). Id of original form (for copies/templates); >0. Form name/title. Owner user id (>0) if set. Form engine identifier (int enum). Available custom reports for this form. Usage restrictions applied to this form. List of custom report definitions. Custom report definitions. Custom report metadata. Custom report id (>0 when present). Custom report name. Inline module form definition used when creating module surveys. Form title/name. Owner user id (>0) or null. Paper format for paper based surveys. Valid value: 'A4', 'Letter', 'Legal'. Should the numeration be displayed. Answer box size; use non-negative values or null for default. Maximum page count; non-negative or null for unrestricted. Maximum questions; non-negative or null for unrestricted. Font family name. Font size; non-negative or null for default. Row height; non-negative or null for default. Creation timestamp (string, ISO-8601). Whether the form is active. Allow result access for participants if true. Header text upper left. Header text lower left. Header text upper right. Header text lower right. Header marker (e.g., label/watermark text). Correction/footer text. Groups/questions to include in the module form. Number of header lines (0-8; null uses default). Optional additional header lines. Layout identifier for online rendering (see OnlineLayoutType enum). Optional folder name/path to place the form into. List of quality guideline configurations for forms. A single quality guideline. For valid values, look into the corresponding type. Quality guideline configuration bound to a form. Configuration id (>0). Name/title of the configuration. List of quality management blocks. List of quality management blocks within a configuration. A single quality management block. For valid values, look into the corresponding type. Single quality management block with weighting and optional code. Block id (>0). Block name/label. Block weight (float, typically 0..1). Optional code identifier. Questions contained in this block. List of quality management questions within a block. A single quality management question. For valid values, look into the corresponding type. Question configuration inside a quality management block. Thresholds and deductions drive guideline scoring; ensure values align with configured calculation type. Question id (>0). Deduction weight (float, typically 0..1). Calculation type identifier. Valid values: 'MEAN', 'CUMULATIVE'. Condition expression. Valid Values: '>' or '<='. Lower threshold; optional. Should be within 0..1 for ratios. Used in mean based calculations. Upper threshold; optional. Used in mean based calculations. Single threshold value; optional. Used in cumulative based calculations. Frequency (float). Used in cumulative based calculations. Filter configuration for forms. Uses item ids (>0), actions/operators (int enums), and optional trigger values. Item id that triggers the filter (>0). Filter action. Valid Values: 0: disabled and greyed out, 1: disabled and hidden, 2: enabled and visible Target item ids (>0) affected by this filter. Optional trigger values (ints), representing an option of a question to trigger the filter, semantics depend on item type. True if this filter applies initially before responses. Logical operator for trigger values. List of filter sets applied to a form. A single filter set. For valid values, look into the corresponding type. List of translations for form groups. Translations for group headers. Translation for a group (section) in a form. Group id (>0). Translated group title. Translated group description. List of translations for items. Per-item translation entries. Translation of a single item with labels for left/right and abstention texts. Item id (>0). Translated item text. Translated left item pol. Translated right item pol. Abstention text. List of form translations. A single form translation. For valid values, look into the corresponding type. Translation of a form with group/item translations and language metadata. Translation id (>0). Form id (>0) this translation belongs to. Translated form name. Translated short name/abbreviation. Filename for PDF output. Logo filename (optional, may be empty). Language id (>0) this translation is based on. Code of the system language this translation is based upon. Language set id (>0). Translation enabled flag. Translations for groups. Translations for items. Main language metadata for a form. Form id (>0). Main language name. Default PDF filename. Logo filename. Language id (>0). Enabled flag. Language set id (>0). Language abbreviation. Position/value pair for detailed item translations. Contains a combination of the translated pole text (value) for a specific option (position) option/position of the option that has a pole text assigned to it Translation of the pole text that is assigned to the given option of the question. List of position/value entries for item translations. A single item Translation with position. For valid values, look into the corresponding type. List of detailed item translations including option values. A single detailed item translation. For valid values, look into the corresponding type. Detailed translation with ordered value positions. Item id (>0). Translated question/item text. Value/position pairs in translated order. Form translation including detailed item translations with positions. Translation id (>0). Form id (>0). Translated form name. Short name/abbreviation. PDF filename. Logo filename. Language id (>0). Language abbreviation/code. Language set id (>0). Enabled flag. Group translations. Detailed item translations with position/value mapping. List of form translations including detailed item data. A single form translation with item details. For valid values, look into the corresponding type. List of localized indicator names. Localized indicator names. Localized name for an indicator. Form translation id (>0) this name belongs to. Indicator name text. List of indicator definitions. A single indicator. For valid values, look into the corresponding type. Indicator definition with referenced items and aggregated stats. Position/order of this indicator on the form(>=0). Indicator id (>0) if persisted. Localized names for the indicator. Item ids that form this indicator (ids >0). Number of responses; non-negative. Mean value (float). Standard deviation (float). Categories assigned to a single form item. Item id (>0). List of categories for this item. List of item-category assignments. A single form item category. For valid values, look into the corresponding type. Single category entry. Category id (>0) when present. Category name, given to categorize open questions. Representing a list of item categories. A single category. For valid values, look into the corresponding type. Category assignments at form level. Form id (>0). Allow free categorization if true. Item-specific categories. Request parameters to fetch categories. Form id (>0). Optional item id (>0) to filter categories. Assignment of a comparison dataset or report to a period/subunit for a form. Provide exactly one of DataSetId or ReportId. Comparison dataset id (>0) when assigning a dataset; leave null when using ReportId. Report id (>0) when assigning a report instead of a dataset; leave null otherwise. Target period id (>0). Must be an internal id. Target subunit id (>0). Must be an internal id. Optional profile line label to show in reports. Optional reporting level flag. Allowed Values: 0: No level defined, 1: Compare system wide, 2: compare on subunit level,3: compare on instructor level, 4: compare on course type level, 5: compare based on program of studies List of comparison dataset/report assignments. A single comparison data assignment. For valid values, look into the corresponding type. Assignments for a form combining period/subunit and dataset/report references. Form id (>0) the assignments belong to. Assignments to apply; omit/null to clear all. Comparison dataset definition with optional per-question statistics. Dataset id (>0 when updating; set 0/omitted when creating). Form id (>0) this dataset belongs to. Dataset name (must be unique per form). Optional per-question benchmark statistics. List of per-question comparison entries. A single data entry. For valid values, look into the corresponding type. Benchmark statistics for a single question. Entry id (>0 when present). Question id (>0) this entry refers to. Median value for the question (null to omit). Mean value for the question (null to omit). Standard deviation (null to omit). Number of responses (non-negative; null to omit). Abstention count (non-negative; null to omit). Restrictions where a form may be used (subunits, course types, periods). An id-list of subunit ids (internal ids). Should be present within the system and follow the usual id-rules (only positive integer numbers) An id-list of course-type ids (internal ids). Should be present within the system and follow the usual id-rules (only positive integer numbers) An id-list of period ids (internal ids). Should be present within the system and follow the usual id-rules (only positive integer numbers) Participant result access flag: -1 deny, 0 inherit, 1 allow without open questions, 2 allow with open questions. Survey header with form, period and state info. Date fields are strings (ISO-8601 recommended); counts are informational. ParticipantResultAccess follows the ParticipantResultAccessValue simple type. Internal survey id (>0 when present). Survey state enum value. Survey title (free text). Usually identical to the course this survey is part of. Survey type label. See tns:surveyTypeEnum for available survey types. Form id (>0) used by the survey. Course id (>0) the survey belongs to. Folder id (>0) if placed in a folder. Open/close flag (0 or 1). Number of returned results; informational. Number of passwords created; informational. Timestamp of last data collection (string; ISO-8601 when consuming). Updated by system. Pagination offset; non-negative when present. PSWD used for instructor optional question workflow (string, may be empty). Mask state enum for optional questions. Assigned outer period object. Participant count; non-negative. Participant result access setting. Filter object for survey queries. Combine optional lists (Ids, Subunits, Instructors, Periods, Forms, CourseTypes, Courses, ProgramOfStudies, Statuses, Types) plus pagination/order and date ranges. Strings are matched against identifiers as configured. Name/title filter (string match). Survey ids as numbers (ids >0 expected). Subunit identifiers (id or name, depending on settings). Instructor identifiers (login/external/id). Period identifiers (id/name per configuration). Form identifiers (ids). Course type identifiers (course type names). Course identifiers (course ids). Programs of study filter values (program of studies names). Survey status filter (state ids as strings). Survey type filter (type ids or names as strings). Open state flag (integer, typically >=0). Max rows to return; use positive values. Order by column. ASC/DESC direction. True to receive extended response as JSON where supported. Lower bound creation date (string, ISO-8601). Upper bound creation date (string, ISO-8601). Lower bound last-change date (string, ISO-8601). Upper bound last-change date (string, ISO-8601). Alias for SurveyIds; strings representing survey ids. Lightweight survey info for listings: ids for period, state and open state, title/type, and optional notices. Internal survey id (>0). Survey state. See tns:SurveyState for available states. Survey title. Survey type label. see tns:surveyTypeEnum for available types. Form id (>0) if present. Owner user id (>0) if set. Course id (>0) if linked. Number of forms; non-negative. Period id (>0) if set. Open state flag (integer, 0 or 1). Optional notices linked to the survey. Helper object to create surveys: references form/period (with id type), survey type and optional owner/course/folder assignments and title. Form identifier; interpreted via FormIdType (id, name, etc.). How to resolve FormId. Period identifier; interpreted via PeriodIdType. How to resolve PeriodId. Survey type enum. Enable verification on creation. Optional notice text. Recipients for form delivery (email). Send participant invitations after creation. Creates an inviteParticipantsTask. Generate serial print artifacts. Optional survey tasks to configure on creation. Survey definition used inside module uploads. Points to period (id+type), survey type, verification/notice/mail settings, optional deletion of existing surveys, form owner or custom form, and associated task list. Period identifier (string interpreted via PeriodIdType). How to interpret PeriodId (internal id, name, etc.). Survey type enum; must be supported by the target course/module. Enable verification for created surveys. Optional notice text. Email recipients for form distribution. Send invitations on survey creation. Delete existing survey of same context before creating a new one. Owner user id (>0) for custom form creation, if used. Inline custom form definition for module survey. Optional tasks to configure on created surveys. Data source enum: Paper (scan/import), Online (desktop), Online (mobile). Participant entry containing result id, person details, timestamp and data source. Result identifier (string as stored by the system). Personal data of the participant, like identifier, name etc.. Submission timestamp (ISO-8601 dateTime), null if not available. Origin of the response (Paper/Online/Online mobile). Filter parameters for participation tracking queries. Subunit identifiers (per configured IdType). Survey ids (as strings; internal ids expected when numeric). Period identifiers (id/name per config). Survey type identifiers/labels. Open-state values as numbers (0 or 1). Passwords/PSWD codes to filter by. Email addresses of participants to filter by. Anonymization status for a survey. Survey id (>0). Total participants; non-negative. Number of participants anonymized; non-negative. List of anonymization status entries. A single anonymization status. For valid values, look into the corresponding type. Composite online survey key: course id/name, instructor, direct link, survey id and transaction number for tracing. Course identifier (string; internal or external). Transaction number for auditing/tracing. Course name/title. Primary instructor information. Direct online survey link (URL). Internal survey id (>0). Online access code entry with optional type/survey linkage. Online code string (password/token). Code type enum (positive int) if present. Valid values: 1: TAC, 2: PSWD Related survey id (>0) if set. Recipient email for this code. Direct online link bound to this code. True if the code has already been used. Summary of participation per survey for a person/password. Internal survey id (>0). Flag, whether the participant actually participated in the survey Details to the participant based on the information within the system. Time unit enum for date aggregations: year, month, week, day, hour, minute, second. List of notices attached to surveys. A single notice. For valid values, look into the corresponding type. Notice/comment linked to a survey and user. Internal notice id (>0). Survey id (>0) this notice belongs to. User id (>0) who created the notice. Notice text content. Date/time string when created (ISO-8601). Is written by the system. Categories of open questions assigned to a survey. Survey id (>0). Item categories linked to this survey. List of survey item categories. Item-specific categories for the survey. Per-item category assignments. Item id (>0). Categories/values for this item. List of result categories for a survey item. A single result category. For valid values, look into the corresponding type. Result/category mapping entry. Result id (>0 when present). Category names/labels. Parameters for category requests. Survey id (>0). Optional item id (>0) to filter. List of calculated quality guidelines per survey. A single quality guideline. For valid values, look into the corresponding type. Calculated quality guideline values for a survey, including blocks/errors when available. Survey id (>0). Survey name. The calculated overall quality index for the survey List of quality management blocks Errors that could happen during the transaction. Includes ERR_201 if no survey was found or ERR_417 if no quality guidelines exist for the given survey. List of quality management blocks in calculated results. A single quality management block. For valid values, look into the corresponding type. Calculated quality block with weights and question list. The weighting, this block has for the overall calculated quality index. Ths calculated quality index of this block. A list fo questions that are used to calculate this quality index List of quality management questions with calculated values. A single quality management question. Calculated quality management question values. The weighting this question has in the calculation in the overall block quality index calculation. The calculated quality index for this question. Task list plus validation errors from save/import. The list of all tasks that are part of a specific survey. A list of errors that occurred while saving the tasks in the TaskList. Grouped task definitions per survey. Each task list is optional and can contain multiple entries. List of NotifySurveyStartTask entries. List of OpenSurveyTask entries. List of InviteParticipantsTask entries. List of RemindParticipantsTask entries. List of NotifyResponseRateTask entries. List of CloseSurveyTask entries. List of SendResultsToInstructorsTask entries. List of SendResultsToParticipantsTask entries. Task definition for NotifySurveyStart actions. Survey the task applies to. When the task should run. Parsed by PHP DateTime; empty or null means no explicit schedule; invalid format triggers ERR_269 Task identifier (filled by the server for existing tasks). Current task status. Name shown as the email sender. Email address shown as the sender. Email body text. Email subject line. Recipients for this task (ids/emails). Task definition for OpenSurvey actions. Survey the task applies to. When the task should run. Parsed by PHP DateTime; empty or null means no explicit schedule; invalid format triggers ERR_269 Task identifier (filled by the server for existing tasks). Current task status. Task definition for InviteParticipants actions. Survey the task applies to. When the task should run. Parsed by PHP DateTime; empty or null means no explicit schedule; invalid format triggers ERR_269 Task identifier (filled by the server for existing tasks). Current task status. Whether an email should be sent. Useful for learning management systems where the participants should be invited, but should recerive no email. Whether multiple mails are combined into one message. Name shown as the email sender. Email address shown as the sender. Email body text. Email subject line. Recipients for this task (ids/emails). Task definition for RemindParticipants actions. Survey the task applies to. When the task should run. Parsed by PHP DateTime; empty or null means no explicit schedule; invalid format triggers ERR_269 Task identifier (filled by the server for existing tasks). Current task status. Repeat interval in days. Whether multiple mails are combined into one message. Name shown as the email sender. Email address shown as the sender. Email body text. Email subject line. Recipients for this task (ids/emails). Task definition for NotifyResponseRate actions. Survey the task applies to. When the task should run. Parsed by PHP DateTime; empty or null means no explicit schedule; invalid format triggers ERR_269 Task identifier (filled by the server for existing tasks). Current task status. Response rate threshold in percent. Response rate calculation method. Name shown as the email sender. Email address shown as the sender. Email body text. Email subject line. Recipients for this task (ids/emails). Enum for response-rate base. Created PSWDs Sent PSWDs Course Participants Task definition for CloseSurvey actions. Survey the task applies to. When the task should run. Parsed by PHP DateTime; empty or null means no explicit schedule; invalid format triggers ERR_269 Task identifier (filled by the server for existing tasks). Current task status. Task definition for SendResultsToInstructors actions. Survey the task applies to. When the task should run. Parsed by PHP DateTime; empty or null means no explicit schedule; invalid format triggers ERR_269 Task identifier (filled by the server for existing tasks). Current task status. Whether an email should be sent. Whether the default report is included. Whether report definitions are included. Name shown as the email sender. Email address shown as the sender. Email body text. Email subject line. Recipients for this task (ids/emails). Task definition for SendResultsToParticipants actions. Survey the task applies to. When the task should run. Task identifier (filled by the server for existing tasks). Current task status. Result access mode for participants. Name shown as the email sender. Email address shown as the sender. Email body text. Email subject line. Recipients for this task (ids/emails). Controls whether participants may view results: -1=No access, 0=Inherited, 1=Access without open questions, 2=Access with open questions. Any other value is rejected during SaveTasks. No access Inherited Access without open questions Access with open questions Recipients for participant-based tasks. Supply internal participant ids and/or email addresses; duplicates result in E-SC-1013 warnings. Participant identifiers to target. Participant email addresses to target. Recipients for instructor-based tasks. Mix explicit InstructorId values with up to three placeholders (Instructor, Dean, Secondary instructors). Placeholder recipients for instructor roles. Instructor identifiers to target. Placeholder enum Instructor Dean Secondary instructors Task lifecycle states Undefined Incomplete Open Running Executed Executed (with warning) Executed (with error) Deactivated Run now No re-run Running error 2 Open, ready to be send Prepared List of task errors. List of task errors. Single task error linked to a survey and task type. Survey the error refers to. Task type where the error occurred. Task identifier involved in the error. Error codes describing validation or processing failures. Possible task error codes include ERR_267 (db), ERR_268 (placeholder), ERR_269 (date format), ERR_271 (unknown), ERR_272 (survey not found), ERR_273 (task running), ERR_274 (result access), ERR_275 (unsupported task type), ERR_276 (recipient has no mail), ERR_277 (recipient missing) List of task error codes. A single task error with code. For valid values, look into the corresponding type. Date is missing Date is invalid Date is invalid for an exam task Recipients are invalid Sender is invalid Missing recipients Date is in the past Unknown error Survey is already closed Not all mails were sent successfully More recipients specified, than online codes available Invalid response rate specified (may only occur on NotifyResponseRateTask) Duplicate recipients Email body was empty Report not accessible for the recipients Survey is still open; results cannot be sent yet Attachment not found No report results No report definition selected Report access denied for codeword-based surveys Not all recipients are linked to online codes Database/persistence error while saving tasks Recipient placeholder is invalid Task date has an invalid format Survey does not support survey tasks Unknown error while saving tasks Survey not found Task is currently running and cannot be changed SurveyResultAccess value out of allowed range Task type is not supported by the survey Recipient user has no email address Recipient user does not exist List of task types used for filtering. A single task type. For valid values, look into the corresponding type. Task type enum: InviteParticipants RemindParticipants CloseSurvey NotifyResponseRate NotifySurveyStart OpenSurvey SendResultsToInstructors SendResultsToParticipants Mail content metadata used in reports or notifications. Displayed sender e-mail. System setting is taken, if empty. Displayed sender name. System setting is taken, if empty. Text of subject line. A text template will be used, if empty Text of the e-mail. A text template will be used, if empty. system language that should be used to determine the correct language for a text template. Is calculated if empty Filter object for course queries/import helpers. Supports name, CourseIds, instructors, subunits, periods, course types, programs, course code, room, external id, custom field entry, flags, select fields, limit/order and JSON response flag. Name/title filter. Course ids as strings (ids >0 when numeric). Instructor identifiers (login/external/id). Subunit identifiers. Period identifiers. Course type identifiers. Program of study filter. Course code filter. Room filter. External id filter. Custom field value filter. Exclude module part courses if true. Restrict returned fields. Max rows to return; use positive values. Order by column. ASC/DESC. True to request extended JSON response when supported. Selectable course field identifiers for course queries. List of course fields to include in responses. A single selected field of the course. For valid values, look into the corresponding type. Course record. Combine internal/public/external ids with descriptive fields, enrollment count, custom fields JSON, owner/period linkage, participants (PersonList), secondary instructors (UserList) and attached surveys (SurveyHolder). Internal course id (>0 when present). Program of study label (free text). Course title/name. Room/location text. Course type id (>0). Public course id (external-facing string). External course id (Could be a foreign key in source system). Enrollment count; non-negative when present. Custom fields serialized as JSON string (must be valid JSON when parsed). Owner/creator user id (>0) if set. Folder id (>0) if assigned. Period id (>0) if assigned. If no period id is present, the course is available in all periods. Ordering position for module parts; non-negative. True if anonymous participants are present. True if this course is part of a module course. Participant list; ids must be >0 when provided. Secondary instructor list; user ids >0. Surveys attached to this course. Wrapper grouping the surveys attached to a course. A single survey attached to the course. For valid values, look into the corresponding type. Module course entry used in module imports. Contains UID, name/code/type, optional program/enrollment/custom fields, instructors and room. Module course unique id (required, caller-defined). Course name/title (required). Course code/short id. Course type label. Program of study. Enrollment count; non-negative when provided. Optional custom fields as JSON (must be valid JSON if set). Instructors attached to the module course. Room/location. Module container for bulk uploads. Holds module identifiers, program/enrollment, period reference, list of ModuleCourse entries, instructors, room, subunit, participants, optional survey creators and anonymity flag. Module unique id (required, caller-defined). Module name/title. Module code/short id. Program of study. Enrollment count; non-negative when provided. Custom fields as JSON (must be valid JSON if set). Period identifier (string, id or name depending on ModulePeriodIdType). How ModulePeriodId is interpreted. List of module courses (at least one expected). Instructors for the module. Room/location. Target subunit name; must match an existing subunit. Participants for module-level surveys; ids >0 when present. True if participant data should be treated as anonymous. Optional survey creation definitions for the module. Course creation payload for bulk/module imports: course ids/names/codes/types, program/enrollment, custom fields, period ref, instructors, room, subunit, participants (incl. anonymous flag) and optional survey creators. Caller-defined unique course uid (required for matching in bulk import). Course name/title (required). Course code/short id (recommended). Course type label; must correspond to an existing course type. Program of study (optional). Enrollment count; non-negative when provided. Custom fields as JSON (must be valid JSON if set). Period identifier; interpreted according to CoursePeriodIdType. How to resolve CoursePeriodId. Instructors assigned to the course. Room/location (optional). Target subunit name; must match existing subunit. Participants; ids >0 when present. True if participants should be treated as anonymous. Optional surveys to create along with the course. Participant/person entity used for course/survey rosters. Supports internal id plus title/name/identifier/email, optional gender/address, and custom fields JSON. Internal participant id (>0 when present). Optional title/honorific. First name (required for inserts). Last name (required for inserts). External identifier/student number; keep unique per source if used. Email address; required. Optional gender code. Allowed values: 1: male, 2: female, 0: gender neutral Postal address (free text). Custom fields serialized as JSON (must be valid JSON when parsed server-side). Course type master data: id, name, optional module form id and external id. Internal course type id (>0 when present). Course type name (required). Optional form id for module usage (>0). If no form is set, this course type cannot be used for module courses. External identifier (string) if mapped from a source system. List of course types. A single course type. For valid values, look into the corresponding type. Status feedback for InsertCourses/Survey operations. Contains survey id, status text, messages and optional task status list (errors per task). Internal survey id (>0 when present). Success or error code occurred during creation of the survey. Example: MSG_001 for Insert successful. Message that corresponds with the given SurveyStatus. A list of status for each task on this survey. Task error without survey context (used when grouped by survey). Includes TaskType, TaskId, and error Codes Task type where the error occurred. Enum TaskType: 1=InviteParticipants, 2=RemindParticipants, 3=CloseSurvey, 4=NotifyResponseRate, 5=NotifySurveyStart, 6=OpenSurvey, 7=SendResultsToInstructors, 8=SendResultsToParticipants, 9=OpenIOQ, 10=RemindIOQ, 11=CloseIOQ, 12=InviteReflection, 13=RemindReflection Task identifier involved in the error. Error codes describing validation or processing failures. Possible task error codes include ERR_267 (db), ERR_268 (placeholder), ERR_269 (date format), ERR_271 (unknown), ERR_272 (survey not found), ERR_273 (task running), ERR_274 (result access), ERR_275 (unsupported task type), ERR_276 (recipient has no mail), ERR_277 (recipient missing) List of task errors per survey when inserting courses. A single Task status. For valid values, look into the corresponding type. List of survey status entries returned from InsertCourses. A single survey status. For valid values, look into the corresponding type. Participant import status (valid/total/invalid list). Number of valid participants that have been added. Total number of participants that should have been added. A list of e-mail addresses that contain all participants that could not be added. Status of a module/course upload including survey and participant states. CourseId the upload status belongs to. The status id given back by the transaction. Could be an error-code or a success code. Examples: MSG_001 for 'insert okay' or ERR_108 for 'incomplete data' Human readable message that describes the status id. List of survey status for this course. list of partcipant status for this course. List of upload status entries. A single upload status. For valid values, look into the corresponding type. Controls how the question list of a PDF report definition is applied. Only questions listed in `Questions` are kept in the report. All form questions are included except the ones listed in `Questions`. Report definition descriptor exported by the report configuration module. Report id (>0). Display title of the report template. True if this is the default report. True if the report is provided by a plugin. Report type id as defined in the report configuration module. JSON encoded array of form ids the report can be used with (empty array = no restriction). Collection of available report definitions. Available report definitions. Single element inside a report configuration (chart/table/etc.). Element id (>0). Element type (string enum, e.g., chart/table). Can be extended by self written plugins. Visibility flag. Ordering position; non-negative. List of elements that make up a report layout. Elements included in the report layout. Full configuration of a report including title, layout and custom settings. Report id (>0). Report title/name. Default flag. Element layout for this report. Additional configuration key/value pairs. Contains the following information based on settings within the system or the report itself: 'thresholdRelative', 'thresholdAbsolut', 'thresholdForOpenQuestions', 'thresholdShowInfoText', 'color1', 'color2', 'color3', 'color4', 'color5', 'color6', 'color7', 'color8', 'color9', 'color10', 'color11', 'profileLineUseMedian', 'profileLineShowStatisticalValues', 'profileLineShowQuestionGroups', 'showRelativeValues', 'includeOpenQuestions', 'splitOpenQuestions', Configuration for report generation. Item ids (>0) to exclude. True to exclude open questions from reports. PDF report plugin descriptor. Plugin id (>0). Display title. Backend class name implementing the plugin. True if this is the default plugin. True if this is a custom (user-provided) plugin. Report type id. Valid values range from 0-5. Informative only. Owner user id (>0) if custom. Filesystem path to plugin. List of PDF report plugins. A single pdf plugin. For valid values, look into the corresponding type. Raw data export for a survey: includes survey metadata, sheet-wise item answers, and optional participants. A single survey. For valid values, look into the corresponding type. Answers grouped per sheet/respondent. Participants tied to sheets (if available). Single answer to an item; values are strings, item ids/codes identify the question. Item id (>0). Item code/identifier. Answer value (string; numeric answers are stringified). Result id/key for this answer row. Option index (non-negative) for choice questions. List of item answers for a single respondent/sheet. Answers for a single sheet/respondent. Collection of answer lists; one list per sheet/respondent. List of sheets; each entry is one respondent's answers. Raw data exports for multiple surveys. Multiple surveys' raw data. Aggregated results for a survey, including per-item and per-group stats. The results in this SurveyResult belong to this survey. A list of item results of this survey. A list of item group results of a survey. Per-item statistics and distributions. Counts are non-negative; means/stddevs are floats computed by the system. Item id (>0). Item code/identifier. Number of responses; non-negative. Number of abstentions; non-negative. Frequencies per option (sum matches responses). Mean value. Standard deviation. Median value. Normed mean value. Only if it can be computed based on settings. List of per-item result statistics. Per-item result entries. Frequencies for all options of one item. Frequency values for each option; non-negative floats. Aggregated result for an item group. Group id (>0) if known. Mean value for the group. Standard deviation. Normed mean value. Only if it can be computed based on settings. List of aggregated results per item group. Per-group result entries. List of aggregated survey results. Result entries per survey. Collection of result changes grouped per survey. A single result change of for a survey. For valid values, look into the corresponding type. List of result changes for a single survey. Survey id (>0). Changes grouped by result entries. List of change blocks for a survey. A single result change block. For valid values, look into the corresponding type. Single result change record. Change record id (>0). Result id (>0) affected. Question id (>0) affected. Timestamp of change. Calculated by the system. Previous (Prior to the change) numeric value (if applicable). Previous (Prior to the change) string value. Statistical results per question. Counts are non-negative; quartiles and H* values are floats computed. Result id (>0) the values are calculated for. Average of all given answers. Abstentions do not count. Depending on system settings, might be trimmed to exclude the outermost data. Median (middle answer) for this question. Variance for this question. Sum of squared deviation from mean. Standard deviation (spread) Count of abstentions for this question Count of answers of this question. For XXL single choice only: option-value|option-value | Encoded option frequencies 1st quartile as of old calculation rulings. No longer in use. Use field quartile25 instead. 3rd quartile as of old calculation rulings. No longer in use. Use field quatrile75 instead. Historically used for calculating the distance between quartile 1 and quartile 3. No longer in use. Relative frequency for answer value 1 |together with the other "HX" values: share of each answer option Relative frequency for answer value 2 |together with the other "HX" values: share of each answer option Relative frequency for answer value 3 |together with the other "HX" values: share of each answer option Relative frequency for answer value 4 |together with the other "HX" values: share of each answer option Relative frequency for answer value 5 |together with the other "HX" values: share of each answer option Relative frequency for answer value 6 |together with the other "HX" values: share of each answer option Relative frequency for answer value 7 |together with the other "HX" values: share of each answer option Relative frequency for answer value 8 |together with the other "HX" values: share of each answer option Relative frequency for answer value 9 |together with the other "HX" values: share of each answer option Relative frequency for answer value 10 |together with the other "HX" values: share of each answer option Relative frequency for answer value 11 |together with the other "HX" values: share of each answer option 10 % quantile for this question 25 % quantile for this question 75 % quantile for this question 90 % quantile for this question Collection of statistical fields for a survey. Statistical values per question/field. Statistical data of a comparison survey (used for benchmarks/plots). Name/title of the comparison survey. Statistical values for the comparison survey. Statistical data sets for multiple comparison surveys. List of comparison surveys' stats. Summary info for a survey (for listings/status overviews). Survey id (>0). Survey title/name. Course code associated with the survey. Subunit name the course of this survey is part of. Instructor name of the instructor this course belongs to. Survey type label. See tns:surveyTypeEnum for available survey types. True if survey is anonymous. Current survey status. Open/close state marker (0 or 1). Period name/label of the period this survey takes place in. Creation timestamp. When was the survey created. Planned start date/time. Date relating to the execution of the task "open survey". Planned end date/time. Date relating to the execution of the task "close survey". Direct online link (if available). True if current user participated (where applicable). Collection of survey summaries. A single survey summary. For valid values, look into the corresponding type. List of PDF report definitions. A single pdf report definition. For valid values, look into the corresponding type. Definition of a PDF report created for a form. Internal id of the PDF report definition (>0). Title/name of the PDF report definition. Description/template text stored with the definition. Form id (>0) the report is based on. List of question/item ids. Interpreted as include or exclude list depending on `PDFDefinitionCreationMode`. Recipient user ids. Special ids: -1 instructor, -2 dean; otherwise internal user ids. Report id (>0) of the base template/plugin to use. Question id used to split subgroup reports; null to disable subgrouping. Include the overall report before subgroup sections (default true). Add a divider with subgroup information between sections. Include open questions in subgroup reports. Survey with its associated verification batches. Internal id of the survey this batch set belongs to (must be >0). List of verification batches (may be empty if none found). List of verification batches belonging to a survey. A single verifier batch. For valid values, look into the corresponding type. Metadata of a scanned batch pending/processed in verification. Internal id of the batch. Total number of scanned pages in the batch. Number of sheets not recognized as forms in this batch. Number of OMR errors/unlocated answers. Name of the scan station used. Sheets that must be or have been verified. List of sheets contained in a verifier batch. A single verfier sheet. For valid values, look into the corresponding type. Single scanned sheet with verification details. Internal id of the sheet. Internal id of the batch this sheet belongs to. Index of the sheet inside the batch (starting at 1). Internal id of the survey this sheet is part of. Internal id of the form used for the sheet. Internal id of the page this sheet represents. Serial number read from the sheet (0 if missing). Counter belonging to the serial number (0 if missing). Email of the participant if encoded on the sheet. Identifier/user id of the participant if available. True if the sheet is a cover sheet. Non-form classification code; 0 means normal form. Encoded image of the scanned sheet (path or base64 depending on configuration). Questions/fields on the sheet that require verification. List of questions to verify on a sheet. A single verifier question. For valid values, look into the corresponding type. Question/field details including coordinates and potential answers to verify. Internal question id (>0). Sheet id this question belongs to. Numeric question type indicator. See tns:QuestionTypes for available question types. Position/index of the question on the page. Data type description (e.g., checkbox, text). Coordinates of the question area on the scanned image. Possible/recognized answers for the question. List of answer options recognized for verification. A single Answer option recognized by the verificator. For valid values, look into the corresponding type. Recognized answer option including fill grade and coordinates. Value of the answer option. Fill level/percentage detected for this option (0-1). Index/position of the answer option. X coordinate of the answer box on the sheet image. Y coordinate of the answer box on the sheet image. Rectangle coordinates on the scanned page (pixels). X origin. Y origin. Width of the area. Height of the area. Type of batch identifier. Identifier refers to a verifier batch. Identifier refers to a scan batch. Batch information returned by the webscan/reader service. Batch id reported by the reader. Internal batch id within the system. Status code of the batch processing. Status/description text. Numeric code for the suggested proceed action. Label for the suggested proceed action. Numeric code for the suggested cancel action. Label for the suggested cancel action. List of webscan batches. A single web scan batch. For valid values, look into the corresponding type. Parameters to filter scan batches. Survey ids to filter by (string list of ints). Batch ids to filter by. Start of time range (schema:dateTime, UTC/local server time). End of time range (schema:dateTime). CRUD operation represented in the activity log. Delete operation. Create/insert operation. Update/modify operation. Domain object the activity log entry is about. Subunit entity. User entity. Course entity. Survey entity. Form/form template. Folder object. Password object (online code). Dataset entry. Image/logo resource. Log entry. Participant/person entity. Custom fields of a person. Assignment between person and course. Assignment between person and survey. Survey task. Online survey email task. Email-to-respondent task. Activity log entry. Internal id of the log entry. Timestamp as string (YYYY-MM-DD HH:MM:SS). Operation type. Type of object affected. Description of the object/value. Identifier of the affected object (string to support mixed ids). Transaction id if available. List of activity log entries. A single activity log entry. For valid values, look into the corresponding type. Entities that can be searched. Subunits. Users/instructors. Courses. Surveys. Participants/persons. System log entries. Deliveries (mailings etc.). Notices/messages. Survey results. List of entity types to include in a search. A single entry list value. For valid values, look into the corresponding type. Evaluation period with id, title and start/end dates (outer period). Inner dates are modeled separately where used. Internal period id (>0 when present). Display title/name of the period. Outer start date (string as stored; use ISO-8601 when writing). Outer end date (string as stored; use ISO-8601 when writing). Volume license meta data: id, volume, cycles, validity dates, activity flag, usage counters and license key. Internal license id (>0). Total licensed volume (non-negative). Number of cycles (non-negative). Start date string (use ISO-8601 when writing). End date string (use ISO-8601 when writing). Activity flag; true if license currently active. Cycles consumed (non-negative). Volume consumed (non-negative float). License key string. List of volume licenses. A single volume license. For valid values, look into the corresponding type. Session token used for UI access forwarding: session id, server ip, start page, token and forwarding key. Session identifier string. Server IP address the session belongs to. Start page URL/path for UI forwarding. Session token string. Forwarding key to authorize UI handoff. Session metadata response: user id/type/subunit, admin flags, login/session timestamps, remaining lifetime and token. Internal user id. internal User type. Primary subunit id. True if user is an administrator. True if user is a subunit administrator. Previous login timestamp. Session start timestamp. Last activity/change timestamp. Remaining session lifetime in seconds; non-negative. Session token string. List of text/email templates. A single text template. For valid values, look into the corresponding type. Single template entry including language, type, subject and body. Internal template identifier. Language name of the template. Language abbreviation (e.g. de, en). Template type key (e.g., email type). True if the template is tied to a specific form. Subject line (for mails). Template body text (may contain placeholders). List of custom user settings. User setting entries. User-specific key/value setting. Setting key/name (string, case-sensitive). Setting value (string; may contain JSON depending on usage). Databridge template descriptor. Template id (>0). Template name. Template type identifier. Optional schedule definition (cron-like string). When should the template be imported automatically. List of Databridge templates. A single databridge template. For valid values, look into the corresponding type. Parameters to query service usage statistics. Start of time window (required). Optional user id filter (>0). Optional end of time window. Integration hub entry (e.g., LMS connection) with settings payload. Entry id (>0). Type of LMS/connector. Serialized settings (JSON/XML as expected by the system). List of integration hub entries. A single integration hub entry. For valid values, look into the corresponding type. xsd:documentation> Configuration for a subunit. Subunit id (>0) the configuration applies to. Key/value pairs of configuration settings. Container for multiple configuration groups. A single configuration group of a subunit. For valid values, look into the corresponding type. System language entry. Language id (>0) if present. Human readable language name. Language file name/path. True if this is the default language. List of available languages. A single language. For valid values, look into the corresponding type. Language' meaning is not described in the implementation. Address entry (per language). Address id (>0). Language id (>0) this address belongs to. Main address text/block. Optional pre-address (e.g., addressee). True if this is the default address for the language. List of address records. A single address. For valid values, look into the corresponding type. Organisation logo payload. Base64 encoded binary data of the logo. Mime type of the logo image (e.g., image/png). User profile including ids, login, external id, contact data, LDAP flag, active/technical admin flags and an optional CourseList of assignments. Internal user id (>0 when present). User type id (role), positive integer, internal usage. See tns:userTypeEnum for all available usertypes. Login/username (must be unique). External id from source system; optional but recommended for sync. Title/honorific. First name. Last name. Unit/subunit name. informational. Postal address. Email address; needed for email-based features. Subunit id this user is part of. Address id /Gender (>0). Password (plain text on insert/update); ignored if LDAP is used. Phone number. True if login is validated via LDAP. Active flag (must be true if the user should be able to log in). True for technical admin accounts. Assigned courses (optional; ids >0). Instructor entity for course/survey relations. Supports UID/login plus name, optional title/gender/contact/language flags and address. Instructor uid (external or internal string, required). Login name (optional, must be unique if used). First name. Last name (required). Title/honorific. Gender indicator (string). Email; needed for email delivery. Phone number. Preferred language code (internal id). Active flag (string representation, e.g. "1" or "0"). Project/group name. Only in Healthcare context. Postal address. Folder metadata for organizing forms/surveys. Includes id, owner user id, creation timestamp, folder name and directory type id. Internal folder id (>0). Owner user id (>0). Creation date/time as string (ISO-8601 recommended). Folder name/label. Directory type id (0 or 1; depending on survey or exam). List of folders. A single folder. For valid values, look into the corresponding type. Filter object for user queries. Supports UserIds, Types, Login/ExternalId/title/name/unit/email, subunits, active flags, limit/order, JSON flag and last login range. List of userIds to search for. List of userTypes to search for. See tns:userTypeEnum for all available usertypes. Login name to search for. external userid to serch for. Title/honorific to search for. First name. Last name. Unit- or project name. Only relevant in QMC context. E-mail address. Internal subunitIds to consider. Is the user an active user. Max rows to return; use positive values. Order by column. ASC/DESC. True to request extended JSON response when supported. Outer last login date/time as string (ISO-8601 recommended). Inner last login date/time as string (ISO-8601 recommended). Subunit entity including contact data and users. Internal subunit id (>0 when present). Name of the subunit. Public unit number if configured. Image access level/rights for scanned open answers. Valid values: 0: Display images after scan, 1: Never display images, 2: display images after data verification Postal code. City. Street and number. Phone number. Fax number. Contact email. Users assigned to the subunit. Logo id used for the subunit. External identifier from source system. True if the subunit is hidden. Logo assigned to a subunit. Logo id (>0) if stored. Display name of the logo. True if the logo is the default for the subunit. URL/path to access the logo. List of subunit logos. A single subunit logo. For valid values, look into the corresponding type. service user login. service user password. Ticket string valid for 30 minutes. Email of participant. Course code to scope passwords. Optional custom field id to match. Passwords to delete if unused. Remaining/affected codes. User identifier (depends on IdType: internal/external/login/name). How to interpret UserId. Include primary courses. Include surveys owned by user. Include participant lists. Include secondary instructor courses. Subunit id (>0). Include primary courses. Include surveys owned by users. Include participants. Include secondary instructor courses. List of users in the subunit (includes optional child objects based on request flags). All periods ordered by date. User to update (identified by internal/external id or username; child collections are ignored). Updated user as stored. User id (>0). Course to insert/update. Form id (>0). Survey id (>0) for preview context. Course to update. True to replace participants with provided list. Period identifier. How to interpret sPeriodId. Include custom report list. Include usage restrictions. Optional filter for usage restrictions. All active forms (optionally filtered/augmented via request flags). List of available survey types (single-character codes). Course id (>0). Period id (>0). Forms approved for the course/period combination. Form identifier (id/name depending on IdType). How to resolve FormId. True to return only question items. Skip inheritance of pole labels if true. Full form definition honoring IncludeOnlyQuestions/SkipPoleLabelsInheritance. Survey id (>0). Survey with metadata and state. Course id (>0). Form id (>0). Period id (>0). Surveys for the course (optionally limited by form/period). Survey object to update. Survey id (>0). Send report to instructor on close. Survey id (>0). Survey id (>0). Number of passwords to retrieve/generate (positive). Code type mask (int) defining if the codes/pswds looked for should be within the already sent codes/pswds or not (1=not send, 2 = send). Force generation even if existing codes are present or if the maximum number of codes in the survey is reached, if more passwords should be generated then available. Mark generated passwords as sent. Request five-digit codes if true (where supported). Online codes created or reused for the survey (marked sent depending on request flags). Exact PSWD/online code to check. True if the PSWD has not been used or reserved. Instructor/user id (>0) owning the survey. Course id (>0) the survey belongs to. Form id (>0) used for the survey. Period id (>0) in which the survey is scheduled. Survey type code. See tns:surveyType for all available survey types. Optional survey description/notice. Set true to mark survey for verification workflow. Created survey including generated ids. User to create/update for the survey owner. Course to create/update and link to the survey. Subunit to create/update; course/user will be placed here. Form id (>0) used for the survey. Period id (>0) in which the survey is scheduled. Survey type code. See tns:surveyType for all available survey types Optional survey description/notice. Created survey (course/user/subunit persisted as needed). Survey id (>0). User id used for permission check and personalized report sections (0 to skip personalization). Optional custom report definition id (0/empty uses default). Optional form translation id to render report (0 uses default language). Require survey to be closed before generating report. Defer/deny generation based on survey task scheduling. If true: generate the report only if the task sendReultsToInstructor is already performed. Download link to generated PDF report (temporary URL). Report definition id to render (matching available PDF templates). Form translation id to render texts; 0 uses default language. Full form definition used for rendering (must match statistical data structure). Meta information about the survey (title, owner, course). Localized text snippets used inside the report. Statistical results for the main survey. Optional comparison survey statistics. Layout/configuration options for PDF generation. Download link to generated report PDF. All subunits available to the caller. Internal/external subunit identifier (interpretation via IdType). Specifies whether SubunitId is internal id, external id or name. True to include instructor list for the subunit. Requested subunit (may be null if not found). User to insert. Inserted user with generated ids. Subunit to insert. Inserted subunit with generated ids. Courses (with instructors/participants) to upsert. True to replace participants for matching courses before import. Status for each processed course/instructor/participant element. Form id (>0). User id requesting plugins (permissions may depend on caller). Available PDF plugins for the form/user context. Form id (>0) to render. Optional survey id (>0) for personalization/scanning. Enable serial printing with unique serial numbers. True to generate two copies per questionnaire. Start serial number (positive) when SerialPrint is enabled. End serial number (>= start when SerialPrint is enabled). Download link to generated questionnaire PDF. Survey id (>0) to generate coversheet for. Download link to generated coversheet PDF. Survey id (>0) whose passwords should be printed. Language abbreviation (e.g., en/de) for the PDF content. Download link to generated PSWD card PDF. Hybrid survey id (>0) to fetch already sent PSWDs. Language abbreviation for PDF content. Download link to PDF with sent PSWDs. Survey id (>0) to export. Omit personal participant data if true (for non-anonymous surveys). Download link to CSV export (temporary). Survey id (>0) to export. Omit personal participant data if true (for non-anonymous surveys). Download link to SPSS export (temporary). User identifier (internal/external/login depending on IdType). Defines how UserId is interpreted. True if the user (and all child data) was deleted. Subunit identifier (per IdType). Defines how SubunitId is interpreted. True if the subunit (and child data) was deleted. Survey id (>0) to delete. Force deletion without two-step safety if true. True if survey was removed. Survey id (>0). Include open text answers if true. Optional explicit result ids to fetch (mutually exclusive with ResultRangeIDs). Include timestamp/source details (non-anonymous only) if true. Optional range of result ids formatted \"start-end\"; cannot be combined with ResultIDs. Raw data and metadata for the survey. Survey id (>0). Statistical results for the survey. Complete form definition to insert. Inserted form including generated ids. Survey id (>0). Participant email to generate link for. Automatically add recipient to survey if not present. Create additional PSWDs if insufficient pre-defined codes. Mark allocated PSWD as sent (default true). Survey link bound to the participant. Participants to add (anonymous or non-anonymous). Course identifier (per IdType). How to interpret CourseId. True to remove existing participants before inserting new ones. True if participant import succeeded. Form identifier (per IdType). How to interpret FormId. Available custom report definitions for the form. Form identifier (per IdType). How to interpret FormId. True to include custom report definitions. True to include usage restriction list. Simplified form representation. Form id (>0) to export. Include secondary data (e.g., pole labels, metadata) if true. Download link to VFD file. Start timestamp (inclusive, ISO 8601). End timestamp (inclusive, ISO 8601). Include open text answers if true. Raw data for surveys with results in the timeframe. Survey id (>0) to attach the notice to. Notice text (plain string, not HTML escaped). User reference (per IdType) for who added the notice. How to interpret UserId. Stored notice including generated ids and timestamps. Modules (with courses/participants/instructors) to insert/update. Status for each processed module element. Survey id (>0). Send instructor notification if true. Optional question mask mode: 1 enable, 11 enable static, 21 enable outcome, 2 remind, 12 remind static, 22 remind outcome, 3 disable. True if state change succeeded. Survey ids to update. Send instructor notifications if true. Optional question mask mode: 1 enable, 11 enable static, 21 enable outcome, 2 remind, 12 remind static, 22 remind outcome, 3 disable. True if all updates succeeded. Survey id (>0). Question groups/items to add to optional question set. True if questions were added and feature enabled. Optional subunit filter (internal ids). Optional form filter (internal ids). Optional survey filter (internal ids). Optional user filter (owner ids). Optional task type filter (use TaskTypeEnum values). Optional period filter. Tasks found along with validation errors for invalid inputs. Tasks to create/update (must reference existing surveys and valid task types). Saved tasks plus TaskError codes for any validation/persistence issues (E-SC-/W-SC-*, ERR_267-ERR_277). Task id (>0) to delete/reset. True if task was removed/undefined; false when the task is missing or already undefined. User identifier (per IdType) to authenticate. How to interpret UserId. Issued session (id, server url, start page). True to return only course types used for modules. Available course types. Definition to create (form-bound). Creation mode controlling overwrite/append behavior. Course identifier (per IdType). How to interpret CourseId. Include survey list if true. Include participant list if true. Course with optional children depending on flags. Course identifier (per IdType) to delete. How to interpret CourseId. True if course (and children) deleted Survey ids to analyze. True to include online responses; false to include paper. Group result counts by survey if true. Aggregation interval (day/week/month). Start of time window (ISO 8601). End of time window (ISO 8601). Generated id for created PDF report definition. Email of recipient whose PSWDs should be returned. Include already used PSWDs if true. When IncludeUsed is true, also include used PSWDs of open surveys. Online codes assigned to the recipient. Participant email to evaluate. Start date (YYYY-MM-DD recommended). End date (YYYY-MM-DD recommended). Optional subunit filter (per IdType). How to interpret SubunitId. Percentage (0-100) of completed surveys. Subunit administrator user id (>0). Subunits the user can administer. User id (>0) owning the license. License key string (not used on standard systems). Uploaded license information (if feature enabled). User id (>0). Volume licenses assigned to the user (empty on standard systems). User id (>0). License id (>0). License key (string) to verify delete. True if license was deleted. Surveys whose open answers should be replaced. Item codes (question identifiers) to target. Replacement text to store for all targeted answers. True if all replacements succeeded. Survey id (>0). Optional sheet id to restrict output (0 for all). Optional scan batch id (0 for latest). Download link to original scans PDF. User id (>0) who uploaded batches. Language abbreviation for status messages. Optional batch status ids to filter. List of webscan batches for the user. Batch id (>0). Action id (as provided by GetWebscanBatchList). True if the action was applied. Form id (>0). True to activate, false to deactivate. True if activation state was updated. Course type name (required). Optional module form id to link (>0). Automatically connect course type to existing forms if true. Optional external identifier. Created course type. Survey id (>0) whose results should be cleared. True if reset succeeded (all results removed). Survey id (>0). Key/value pairs matching field names/item codes to prefill. Optional list of PSWDs to prefill; empty applies to all PSWDs. Number of PSWD records updated with prefilled data. Filter parameters (name, units, instructors, period, form, status, etc.). Survey ids (and optional extended info if requested). Subunit id (>0) receiving quota/volume. Volume/quota amount to assign (non-negative). True if assignment succeeded. Form id (>0) to delete (deletes connected surveys). True if form deletion succeeded. Existing course type id (>0). New course type name. Optional module form id to link (>0). Connect to existing forms if true. External identifier (optional). Updated course type. Course type id (>0) to delete. True if deletion succeeded. Form id (>0) to read filters from. Optional survey id (>0) to prefer survey-level filters; 0/omitted uses form-level. Filters controlling item visibility. Form id (>0) for storing filters. Optional survey id (>0) to store survey-specific filters; 0 for form-level. Filter sets defining conditions for items/groups. True if filters were saved. Form id (>0). Optional survey id (>0) to delete survey-level filters; 0 deletes form-level filters. True if filters were removed. Emails to enqueue (subject/body/recipients set per entry). Emails accepted into the queue (may include processing flags). Survey id (>0) to check verification info. Verifier information for the survey. Survey id (>0). Serial number on the sheet/card. Serial number counter (if used) for disambiguation. Verification data for the given serial number. Survey id (>0). Identifier (email/custom field depending on survey) for participant. Verification data for the participant. Batch identifier (>0). Defines whether BatchId refers to webscan or readerscan id. Survey id (>0) for context. Verification details for the batch. Existing session id/token. True to re-open a suspended session if possible. Session details and user info. User id (>0) whose configuration should be read. Key/value pairs of user-specific configuration. System-wide configuration grouped by category. Form ids to delete (cascades to surveys). Per-form deletion result (id → status/message). Username/login of the user. Clear-text password for authentication. User object if credentials valid. Email address of the participant. Pipe-separated survey type codes to include (empty defaults to online/hybrid/paper). 0=open surveys only, 1=closed surveys only, other/null=all. Summary per survey including participation status. PDF report definition id (>0). Report definition details. Form id (>0) whose report definitions should be listed. Report definitions bound to the form. Form id (>0). Available translations for the form and items. Form id (>0). Translations including options/pole labels. Forms to fetch quality guideline configuration for. Guideline configuration per form. Survey ids to fetch guideline evaluation for. Applied guideline results per survey. User identifier (internal/external/login) based on IdType. How to interpret UserId. Include primary courses if true. Include surveys if true. Include participants if true. Include secondary instructor courses if true. User(s) matching the identifier. Ids of all text templates available. Template id/name. Optional form id to resolve form-specific template (0 for global). Matching templates (language variants). PSWD/online code to summarize. Usage summary of the PSWD. User id (>0) whose folders to list. Folder hierarchy accessible to the user. Folder id (>0). Surveys contained in the folder. Form id (>0). Optional survey id for survey-specific indicators. Indicators (group aggregates) for the form/survey. Custom setting key (string identifier). Value to store (stringified). Status text (e.g., OK or error message). Custom setting key to delete. Status text (e.g., OK or error message). Custom setting key to fetch. Requested setting (key/value pair). All custom settings for the current user. Survey id (>0). All notices for the survey. Notice id (>0) to update. Updated notice text. Update the timestamp to now if true. Updated notice. Notice id (>0) to delete. True if notice removed. Survey id (>0). Result start timestamp (ISO 8601). Result end timestamp (ISO 8601). Interpret answers as export values rather than raw positions if true. List of sheet results to import (per participant/submission). Resulting survey status after import. License meta information (edition, expiry, modules). Available databridge templates. Template id (>0) to trigger. URL to import result/log file. Filter parameters for forms (id/name/subunit/etc.). List of form ids or extended info per request flags. Form id (>0). Restrictions to apply (subunit/period/owner filters). Restrictions stored. Survey id (>0) to invite for. True to send reminder invitations. Optional prefix for progress tracking identifiers. Status text for invitation job. Distribution data (per chosen aggregation) serialized as strings/JSON. Survey id (>0) to reassign. Target user id (>0). Send report to substitute user after move if true. Move owning course as well if true. Status text. Filter parameters (name, unit, role, etc.). Matching user ids/identifiers. Course filter parameters (name/code/program/etc.). Course ids or JSON records if ExtendedResponseAsJSON was requested. User id (>0) to move. Destination subunit id (>0). True to overwrite matching user in target; false to create new. Status text (\"Success\" or error message). Parameters (JSON-like) to filter reader scan batches. JSON strings describing matching batches. Filter parameters (JSON-like) for participation tracking. JSON strings describing tracked participation. Survey ids to evaluate. Response rate info per survey/method (JSON strings). Translations to store (structure identical to GetFormTranslations response). True if translations were saved. Main language mapping to apply. True if main language updated. service login name to evaluate permissions for. Transaction name → allowed (true/false). SQL query string (internal use). Result rows serialized as strings. Properties to update (name/title/activation/etc.). True if properties saved. Global configuration entries to set. True if saved. User login name. New password (plaintext). True if password updated. Optional subunit ids to limit results. Programs of study names. Form identifier (per IdType) whose module group titles change. How to interpret FormId. Field name → new title mappings. True if titles were updated. User id (>0). URL or local path to image (empty string removes image). True if image updated/removed. Search keyword (supports [*] wildcard). Entities to search within. List of matching entity descriptors. Parameters (from/to timestamps, login filter) for usage statistics. Usage metrics per user/transaction. Survey ids to export. Download link to ZIP with CSV exports. Email addresses/identifiers to anonymize globally. True if anonymization executed. Surveys whose participants should be anonymized. Status per survey (success/error per participant). Filter parameters (form ids, items) for categories. Category definitions for the requested form/items. Categories to insert/update for a form. Stored categories. Categories/items to delete (empty to delete all for form). Deleted categories/items. Survey/category filter parameters. Assigned categories for survey answers. Category assignments to insert. Stored assignments. Assignments to delete (empty removes all for survey). Deleted assignments. User id (>0) whose sessions should be destroyed. True if session removed. Comparison dataset to insert/update (name must be unique per form). Stored dataset. Comparison dataset id (>0) to delete. True if dataset removed. Comparison dataset id (>0) to fetch. Comparison dataset details. Assignments of dataset/report to form/period/subunit. True if assignments persisted. Form id (>0) whose assignments are requested. Assignments for the form. Delete log entries older than this number of days (>=0). Fault/result information (null on success). Delete activity logs older than this number of days (>=0). Optional transaction names to restrict deletion. Fault/result information (null on success). Delete delivery log entries older than this number of days (>=0). Fault/result information (null on success). Survey ids to process. Statistical results per survey. Survey ids to fetch. Include open text answers if true. Optional explicit result ids per survey (exclusive with ResultRangeIDs). Include timestamps/source info if true. Optional range \"start-end\" per survey; cannot combine with ResultIDs. Raw data list per survey. Survey id (>0) for single-password QR code. Download link to QR code image. Logos per subunit. Subunit to update (identified by id/external id). Updated subunit. Survey id (>0). True for permanent link; false for 20-minute link. URL to HTML report. Survey id (>0). Mail content/settings for participant notifications. Recipient identifiers successfully sent. Recipient identifiers that failed to send. PSWD/online code to reset (non-anonymous surveys only). True if PSWD was reset to unused. Configured system languages. Available addresses (mail profiles) in the system. Report id (>0). Configuration details for the report. All available report templates. Organisation logo image data/meta. Surveys to retrieve result change history for. Change records per survey. Task id (>0) to schedule for immediate execution. Gets a ticket string which can be used for further service communication with the web server ("ticket" in the service header). The ticket has a lifetime of 20 minutes and gets invalid if there is no transaction using the ticket. Alternatively it is possible to use the credentials ("login" + "password") directly in the service header.

Returns unused online access codes (PSWD) for the shown email address and course code (aka. ID) in the period of the current date. The course code is optional. If it is empty all courses are considered. Closed surveys are ignored. The participant needs to be assigned to the corresponding course. If the survey has survey tasks, there will only be a result if the open survey task is not open, the invite participants task was already executed or there is no invite participants task and the close survey task is still open. Optionally, the given value for the user mail address can be matched against a custom field (1-3) of the participant.

Deletes the presented passwords from the database and returns a list of the deleted PSWDs. Only unused PSWDs are deleted -> this is why the deleted PSWDs are returned.

Returns user, referenced by his internal user ID, an external ID which was imported previously into the system or a user name. If no user is found, an error is returned. The boolean variables determine if the parent object user will also contain the child objects course, survey and participant.

Returns all users of the subunit of the type instructor. The boolean variables determine if the parent object user will also contain the child objects course, survey and participant.

Returns all defined evaluation periods, sorted by date.

Updates the presented user in the database. Please note: Child objects, like courses, will not be updated by this method. Please use the method "InsertCourses" for mass import/update of course and instructor data.

Returns all courses for the specified user (ID). Returns an error, if the user has no courses.

Returns the course, referenced by the internal course ID, the external ID which was imported previously or the editable course ID. The boolean variables decide if the parent object "Course" also contains the child objects "Survey" and "Participant".

Inserts the presented course into the database. Please note: 1) Child objects of type "Survey" will not be imported by this method. Please use the method "InsertCentralSurvey" for inserting surveys. 2) Child objects of type "Participant" have to be imported accordingly. Please use the method "InsertCentralSurvey" for inserting surveys, too.

Creates a link to show the preview of an online survey. If a survey ID is submitted, the questionnaire is shown in the context of the survey, otherwise, the form preview is shown.

Updates the presented course in the database. Please note: 1) Child objects of type "Survey" will not be updated by this method. An update of existing surveys is not possible at all. 2) New course participants should be given by the 4th parameter . In order to delete existing participants prior to the import of new participants, the second parameter has to be set to "true". Participants of existing surveys will not be affected by this function.

Returns a period referenced by its period ID, period name or period date (format YYYY-MM-DD).

Returns all active forms of all users stored in the system. Restrictions can be used to get forms e.g. of specific subunits.

Survey types are hard-coded single characters and will never be changed. Due to performance reasons, it is not recommended to call this transaction continuously in live systems.

Forms can be assigned to specific course types and periods in the system. Use this transaction to get the "approved" forms for a course.

Returns the questionnaire/form referenced by its internal form ID or the questionnaire short name. The objects returned include all question groups and questions. Secondary questionnaire properties such as filter settings are not included. If the parameter "IncludeOnlyQuestions" is true, only questions will be returned and no layout elements like free text, horizontal lines, etc.. If the parameter "SkipPoleLabelsInheritance" is true, scaled questions will not inherit the pole lables of prior (extended) pole labels fields automatically.

Returns the survey referenced by its survey ID.

One course can have more than one survey in different periods or with different forms. To reduce the number of surveys, it is possible to set the parameters for the form and the period. Possible values for m_nState in SurveyList:<br/>0: Ready (waiting for data)<br/>1: Data available<br/>2: Data deleted<br/>4: Quantity of data too low<br/>5: data capturing<br/>6: Verification

Updates the displayed survey in the database. Please note: This method has to be used very carefully. Incorrect usage could cause several problems including data loss. Use "OpenSurvey" and "CloseSurvey" instead.

Closes the survey referenced by its survey ID -> further data collection is not possible for this survey.

Opens the survey referenced by its survey ID -> data collection is possible for this survey.

Returns the online access codes (PSWD) for the displayed survey ID encapsulated in a OnlineCode object. If the second parameter is 0, the predefined PSWDs will be returned. Should the number of requested PSWDs exceed the number of existing PSWDs, this method automatically creates new PSWDs by default. All PSWDs are set to "sent" by default.

Checks whether the password shown is unused.

Creates a new survey for central evaluation based on internal IDs.

Creates a new survey for central evaluation based on given objects. This method also inserts the subunit, user and course objects if they do not already exist.

Creates the PDF report for a survey and returns a hyperlink to the document. "onlyIfSurveyTasksAllowIt" will hold back the report, until the "SendResultsToInstructorsTask" is planned to execute. If "SendResultsToInstructorsTask" does not exist, but "CloseSurveyTask" does, that task is considered instead. The default for it is "false".

Creates the PDF report from the given Data without havin the survey or forms in the system and returns a hyperlink to the document.

Gets all subunits which are stored in the database.

Gets a subunit by the name presented. Note: In the system it is possible to have two or more subunits with the same name, but in this function, we only return the first. The boolean variable determines whether the parent object "subunit" will also contain child objects of the type "user".

Inserts the user shown into the database. Please note: Child objects like courses will not be inserted by this method. Please use the method "InsertCourses" in order to mass import/update course and instructor data.

Inserts the presented subunit into the database. Please note: Child objects of type "User" will not be inserted by this method. Please use the method "InsertCourses" for mass import of course and instructor data.

Transaction for mass structure data uploads. The transaction determines whether the presented courses and instructors already exist in the system and performs an INSERT or UPDATE operation. This method provides the opportunity to upload multiple instructors (first instructor will be setup as main instructor) as well as a list of course participants. Since V5.0 this method includes the following sub-functions: - Create surveys - Configure scheduled tasks for online surveys - Send email with PDF questionnaire to defined email address - Send email invitation for online surveys to given participants

This transaction returns a list of all available PDF Plugins for the presented form ID.

Creates a PDF questionnaire and returns the hyperlink to the file. If a survey ID is submitted, the questionnaire is personalized for the survey and can be used for scanning (hard copy procedure). For coversheet procedure, the second parameter should not be set.

Creates a PDF coversheet and returns the hyperlink to the file. The coversheet is personalized for the survey and can be used for scanning (coversheet procedure).

Creates a PDF with the PSWDs (cards) and returns the hyperlink to the file.

Creates a PDF with the already sent PSWDs (cards) for only hybrid surveys and returns the hyperlink to the file.

Creates the CSV export file of the survey and returns the link to the file. The optional parameter ExcludeParticipantPersonalData can be used to suppress personal data for non-anonymous surveys.

Creates the SPSS export file of the survey and returns the link to the file. The optional parameter ExcludeParticipantPersonalData can be used to suppress personal data for non-anonymous surveys.

Deletes a user including all (!) child elements (courses, surveys, survey results, etc.).

Deletes a course including all (!) child elements (surveys, survey results, etc.).

Deletes a subunit including all (!) child elements (users, courses, surveys, survey results, etc.).

Deletes a survey including all (!) child elements (survey results, etc.).

Creates an object which includes all sheet results (raw data) of the given survey. The SurveyRawData object also contains the survey object. The answers to open ended questions can optionally be included and in case of non-anonymous surveys the timestamp and the source of data may be included.

Creates an object which includes all statistical results for all questions and question groups (indicators) of the given survey. The SurveyResultRawData object also contains the survey object. Statistical results include: Response count, mean, median, standard deviation, frequency distribution, abstention count, normed mean.

This method inserts a complete form/questionnaire into the database. The object returned contains the given internal database keys. The owner of the form will always be the main administrator. Notes: <ul><li>An update of existing forms is not possible.</li><li>Deleting forms via service is not possible.</li><li>The form elements "Picture" and "Double scaled question" are not yet supported by this transaction.</li></ul>

Returns a link to the online survey for the presented email address and the internal survey ID. In order to automatically link the recipient to the survey, the parameter "AddRecipientToSurvey" should be set to "true". If this parameter is set to "false" and the recipient is not already linked to the survey, this function will return an error. The 4th parameter determines if new PSWDs are to be created in case not enough PSWDs were predefined. Optionally with SetPSWDToSent (default - true) it can be defined that the PSWD is not directly marked as "sent".

This method accepts anonymous participants (email must be set) and non-anonymous participants (other person properties can be set). With the boolean parameter, it is possible to remove all existing course participants before the new given participants are added. Please note: It is also possible to include the participants into the course object and to call either "InsertCourse" or "UpdateCourse".

The operation returns a list of available PDF report definitions of a given form.

Returns a simplified version of the form referenced to by the form ID.

The function exports a form into an .vfd (=VFD/VividForms form definition file ) file and returns a link to it.

Returns raw result data of all surveys that received results in the defined timeframe. The returned results are not limited to the defined timeframe. All results of the relevant surveys will be returned.

Inserts a notice to a survey for a specified user. The user can be referenced by internal (PK), external (FK) or login (username).

Inserts a group of modules (that can contain groups of courses) into the system, It supports both Inserting and Updating of the data. It is also able to create a module-survey on them. The function determines if the courses are already in the system and then calls the UpdateCourse method. This method includes the following sub-functions: - Insert module participants - Insert secondary instructors - Create surveys - Configure scheduled tasks for online surveys - Send email with PDF questionnaire to defined email address - Send email invitation for online surveys to given participants

Enables/disables extending of the questionnaire of a specific survey with additional questions. Additionally it is possible to remind the instructor, that he is able to customize the questionnaire. If the second parameter is set to true, the instructor is provided with an information email, that contains a link to the editing environment. This functionality is called Instructor's Optional Questions or "Meldemaskenverfahren" in German.

Same as ActivateOptionalQuestionsForSurvey, but accepts a List/Array of SurveyIDs and therefore gives the possibility to enable, remind or disable optional questions for a group of surveys.

Same as ActivateOptionalQuestionsForSurvey, but gives the opportunity to add some question groups and question directly with the same service operation.

Returns scheduled tasks filtered by optional Subunit/Form/Survey/User/TaskType/Period ID lists. Invalid IDs are ignored; an ID list containing only invalid values yields an empty result. Invalid TaskType values fault with ERR_263.

Updates survey tasks. Each task must belong to an existing survey and supported task type; running tasks are rejected. StartTime/Status are optional (Status uses TaskStatus 1-13); SurveyResultAccess must be -1/0/1/2 and placeholders must use the InstructorPlaceholder enum (1/2/3). Validation issues (invalid recipients/placeholders/dates/result access, missing surveys/users, running tasks) are returned as TaskError codes (E-SC-/W-SC-*, ERR_267-ERR_277) alongside the echoed tasks; only unexpected persistence errors fault with ERR_267.

Removes a task (sets it to undefined). Returns false if the task does not exist or is already undefined; unexpected failures fault with ERR_261 (details are logged).

Returns a session for a given user ID. The session object contains the session ID, the server URL and the user start page. This method can be used to authenticate users via service.

Sends an information mail to participants of a survey, when they are allowed to view the report results. The survey and/or the form must be enabled for participant reports and the survey must be closed.

Returns a list of course types. Optional only course types which are used for module evaluation.

PDF report definitions can be used to distribute full or partly survey reports to defined users. The PDF report definition is set up for a form. This method inserts the PDF report definitions for a form and returns the ID of the PDF report definition. The ID can be used in method "GetPDFReport".

Returns unused (or, optional also used) online access codes (PSWD) for the shown email address. The access codes have to be sent out previously so that an access code is already assigned to the recipient. As default, closed surveys are ignored for unused, and open surveys are ignored for used PSWDs. With "IncludeUsedOfOpenSurveys", the used PSWDs of closed surveys are returned as well.

The method returns the percentage of surveys a participant has completed in a given time frame and subunit. This method considers anonymous and non-anonymous online surveys as well as non-anonymous paper surveys. The participant data need to be imported to a course prior to the survey creation.<br/><br/>The following Surveys are considered:<br/><br/>Surveys without scheduled tasks and a period which the start date of the given time frame is within the period.<br/>Surveys without scheduled tasks and a period which its start date is within the given time frame.<br/><br/>For Surveys with scheduled tasks:<br/><br/>When both first scheduled task and close survey task are defined then:<br/>The start date of the given time frame is within the tasks dates<br/>Or date of first task is within the given time frame.<br/><br/>When only first scheduled task is defined then:<br/>Task start date should be before the end date of given time frame.<br/><br/>When only last scheduled task (survey close) is defined then:<br/>Task should be ended after starting the given time frame.

Returns all accessible subunits for the presented user id (only for subunit administrators).

This function doesn't work on a standard system. It is not possible to upload a volume license.

This function doesn't work on a standard system. It is not possible to get a volume license.

This function doesn't work on a standard system. It is not possible to delete a volume license.

Updates answers to open questions with the provided comment.

Create the original scans PDF for a survey / batch and return the link to the PDF.

Get a list of all unfinished scan upload batches of a specific user. If specific batch-status-Ids are given(optional), then all batches with the given status will be delivered.

Apply the given action on a scan upload batch. Possible actions are determined by calling the GetWebscanBatchList transaction.

Set the activation status of a form to activated or deactivated.

Inserts a new course type. Optional it is possible to link to a module questionnaire.

Resets the data of a survey. All survey results are deleted!

Inserts data for an existing online survey. The data is stored like temporary save has been used. When the participant opens the survey, the participant can check the pre-filled data, complete the survey and submit the data. The PSWD and all IDs have to correct and there if there is already temporarily saved data, the function doesn't add or change anything.

Get a list of survey IDs by the given parameters (Name, Subunits, Instructors, Periods, Forms, CourseTypes, Courses, ProgramOfStudies, Statuses, Types). For the parameter "Name" a wildcard "[*]" may be used as a substitute for zero or more characters.

DEPRECATED: Please use GetSurveyInformationByParams instead

This method assigns volume to a subunit, which can be completely used by that subunit.

Deletes a form including all (!) belonging surveys and child elements (survey results, etc.).

Updates an existing course type. Optional it is possible to link to a module questionnaire.

Deletes an existing course type.

Get a list of filters for a specific form. The filters are used for hiding/deactivating questions in online surveys. The filters are also considered when paper-based surveys are processed. If a survey ID is given and filters on survey level are defined, the survey level filters are returned. No filters are returned if a survey ID is given but there are no filters on survey level. In that case filters on form level are ignored. There are 3 values available to define the filter action: 0 - disable; 1 - disable and hide; 2 - enable and show

Set the filters for a specific form. Existing filters on form level are overwritten. The filters are used for hiding/deactivating questions in online surveys. The filters are also considered when paper-based surveys are processed. If a survey ID is given, the filters are overwritten on survey level. In that case the filters on form level are left untouched. There are 3 values available to define the filter action: 0 - disable; 1 - disable and hide; 2 - enable and show

Delete all existing filters of a specific form. The filters are used for hiding/deactivating questions in online surveys. The filters are also considered when paper-based surveys are processed. If a survey ID is given and filters on survey level are defined, the survey level filters are deleted. In that case the filters on form level are left untouched.

Add one or more emails to the queue. The emails are sent by the MailService tool.

Returns detailed information about the pending verification of the survey. There is data about the survey, batch, sheet, question and answer, including the coordinates of detected marks. With this data it is possible to monitor the verification or to get all data and continue an external process.

Returns detailed information about the pending verification of a single participant by serial number. There is data about the survey, batch, sheet, question and answer, including the coordinates of detected marks. With this data it is possible to monitor the verification or to get all data and continue an external process.

Returns detailed information about the pending verification of a single participant by email address. There is data about the survey, batch, sheet, question and answer, including the coordinates of detected marks. With this data it is possible to monitor the verification or to get all data and continue an external process.

Returns detailed information about the pending verification of the batch. There is data about the survey, batch, sheet, question and answer, including the coordinates of detected marks. With this data it is possible to monitor the verification or to get all data and continue an external process.

Returns the relevant information for an existing session. Optionally the session can be resumed.

Returns the relevant configuration options for an existing user.

Returns the relevant configuration options for all subunits in the system as an array.

Deletes a list of forms (max. 100). Only unused forms are deleted.

Returns user, referenced by login and password. If no user is found or the password is wrong a message is shown. 3 invalid login attempts for a specific login, lead to a 15 min blockade.

Returns a summary of evaluation (e.g. survey details, scheduled tasks details, link to online survey, participation status) for surveys to which a participant was assigned. This method considers anonymous and non-anonymous online surveys as well as non-anonymous paper surveys. The survey types can be limited with an optional parameter.

PDF report definitions can be used to distribute full or partly survey reports to defined users. This method returns a PDF report definition for a form by the given ID.

PDF report definitions can be used to distribute full or partly survey reports to defined users. This method returns a list of PDF report definitions by the given form ID.

This method returns a list of form translations by the given form ID.

This method returns a list of form translations by the given form ID. Additionally, it returns all translations of a question, considering pole labels.

This method returns all quality guidelines for a given form IDs.

This method returns the image of the organisation as a base64 encoded string.

This method the calculated quality guidelines for the given surveyids. If they cannot be calculated, an Error-Value will return the reason.

Returns a list of all available text templates in the system. The content for the text template can be requested with the transaction "GetTextTemplateById".

Returns a text template by the given Id. Optionally by giving a form ID, the form specific text template is delivered. The result includes the text template contents for all system languages.

Returns a list of system users, where all users in this list have the same external id referenced by an internal user ID, an external ID which was imported previously into the system or a the system user name. If no user is found, an error is returned. The Boolean variables determine if the parent object user will also contain the child objects course, survey and participant.

Returns an object with summarized information for a given PSWD. The object contains the survey ID, the information if the PSWD was used and the participant object if isset.

Returns a list of all folders for the given user Id of an active user account. This transaction may also be used for getting access to the reports of a report creator account.

Returns a list of surveys for a given folder Id. This transaction may also be used for getting access to the reports of a report creator account.

Returns a list of all indicators for a given form Id. As long as there no free indicators exist, the indicators for question groups with dimension values are returned. Optionally by giving a survey Id, the survey specific values for mean and standard deviation are delivered.

Inserts or updates a setting for the given key. The key can be up to 255 characters. The value can contain any text like JSON, array or simple text. The settings are bound to the current service user.

Deletes a setting for the given key. The settings are bound to the current service user.

Gets a setting for the given key. The settings are bound to the current service user.

Returns a list of all settings. The settings are bound to the current service user.

Returns a list of all survey notices for the given survey ID.

Updates a survey notice text by the given ID. Optionally the date is updated.

Deletes a survey notice by the given ID.

Inserts raw data for the given survey ID. Optionally the time span used for the date of each result can be set.

Returns a list of relevant license information, which might be used to distinguish between different system environments.

Returns a list of active Data Bridge templates.

Triggers the import process for a specific Data Bridge template and returns the url of the file name with json serialised content.

Returns a list of forms information by the given parameters (SelectedFields, Users, SearchQuery, IncludeFormsOfOtherSubunitAdministrators, IncludeStatus, IncludeDeactivatedForms, ExcludeActiveForms, FolderId, IncludeChildForms). For the parameter "SearchQuery" a wildcard "[*]" may be used as a substitute for zero or more characters. The SearchQuery searches in short name, description and IDs of the forms.

Sets access of subunits, course types and periods to a specific form.

Sends out invitation or reminder mails to all participants of an online survey.

Returns the distribution of responses (online or paper based) for one or more survey IDs. The list can be left blank in order to have a summary for the whole system. The data can either be grouped by survey ID or aggregated over all surveys. The time span can be limited by entering a start and / or an end time.

Moves a survey to a substitute user. The current PDF report can be sent to the substitute user. The course of the survey can be moved (if only one survey exists) or copied to the substitute user.

Returns a list of user IDs by the given parameters (UserIds, Types, LoginName, ExternalID, Title, FirstName, SurName, UnitName, Email, Subunits, ActiveUsers). For the parameters LoginName, ExternalID, Title, FirstName, SurName, UnitName, or Email a wildcard "[*]" may be used as a substitute for zero or more characters. If ExtendedResponseAsJSON is set, a json string is returned with more information about the user. The result can be ordered by each returned field.

Returns a list of course IDs by the given parameters (Name, CourseIds, Instructors, Subunits, Periods, CourseTypes, ProgramOfStudies, CourseCode, Room, ExternalID, CustomFieldEntry). For the parameters Name, ProgramOfStudies, CourseCode, Room, ExternalID or CustomFieldEntry a wildcard "[*]" may be used as a substitute for zero or more characters. If ExtendedResponseAsJSON is set, a json string is returned with more information about the course. The result can be ordered by each returned field.

Moves the given user to another subunit. Subunit administrators cannot be moved. The parameter OverwriteSimilarUser defines what should happen with users that already exists in the target subunit (same title, first name, surname, unit name, user type). Should the user be moved as new user, or should the existing user be overwritten? Default: Move as new user.

Returns a list (JSON) with detailed information of all scanned batches in the Scanstation.

Returns a list (JSON) with all participation tracking information on the basis of the given parameters. As an extension to existing transactions the request is not limited to a specific participant.

Returns a list (JSON) with all response rate information for each calculation method (number of PSWDs created, number of PSWDs sent, number of course participants) on the basis of the given survey IDs.

Sets the translations for one or more form(s) with its group and item lists. The request body is equivalent to the response body of GetFormTranslations.

Sets the main language for a form or changes an existing main language. This can be used to set the main language before a call of the service transaction SetFormTranslations.

Returns a list of all transactions and the information if the specified user has the transaction right to call it.

Internal Transaction

Update the properties of a questionnaire of an administrator or subunit administrator. It is possible to update these properties: FormName, FormTitle, Activated, Extensible, ResultAccess, FormProcedure, FormSurveyType, FormFolder, OnlineLayout, OnlineTempSave

Internal Transaction

Internal Transaction

Returns a list of program of studies by the given parameters

Updates the group titles for automatically created module questionnaires. Please note: The transaction should not be used for questionnaires that have already been distributed, since the recognition set is rewritten and the data may no longer be read.

Sets an image for an user account based on the internal user ID that is loaded from an URL or an accessible local server path. If an empty string is passed for the path, only the previous image is removed.

Returns a list of entity information by the given keyword. This transaction allows a full text search for information within the most important entities (Subunits, Users, Courses, Surveys, Participants, Logs, Deliveries, Notices, Results). For the parameter "Keyword" a wildcard "[*]" may be used as a substitute for zero or more characters.

Returns the amount of service request since a timestamp.

Creates a ZIP archive with CSV export files of several surveys (with additional data like subunit, owner, course and period) and returns the link to the file.

Anonymizes the given participant emails/identifiers in the whole system.

It anonymizes all participants of the given surveys as far as possible. It checks first whether a participant can be anonymized or not.

Returns a list of categories for open questions that are defined for the given form.

Updates or inserts the open question categories for the given form.

Deletes the categories for open questions for a given form. If only formId is specified, all categories of this form will be deleted. If certain items are specified, only the categories of the specified items will be deleted. If certain categories of items are specified, only those categories will be deleted.

Returns a list of categories that are assigned to the answers of open questions of the given survey.

Inserts the categories for the answers of open questions of the given survey.

Deletes the categories assigned to answers of open questions in a given survey. If only the surveyId is specified, all assigned categories of this survey will be deleted. If certain questions are specified, only assigned categories of the specified questions will be deleted. If certain categories of questions are specified, only those categories will be deleted.

Destroys a session of an user by internal user ID.

Saves a set of comparison data for a questionnaire. These function can save and insert comparison data. To insert new data, the id must be empty. However, the name must be unique per questionnaire. If a data set is updated, it has to be defined completely, as existing data will be removed before these are inserted. There is only one set for each question id possible and the result range has to be in the range of the possible values for this question. Keep in mind that this function will not consider if the form is mirrored. If so, the results have to be mirrored before inserting them. It will also not check if the value is plausible.

Removes a set of comparison data from the database and also removes the assignments to surveys, if they exist. Returns the success as bool value.

Get a set of comparison data by id. These comparison data are saved by questionnaire and can be get by GetComparisonDAtaAssignments.

Assigns a Comparison Data Set or a report to a combination of period and subunit. These assignments have to be unique for the questionnaire, period and subunit and have to be complete. All assignments of a form have to be in this request. Those who are missing will be removed. To get all assignments, use GetComparisonDataAssignments.

Get all ComparisonDataAssignments for a questionnaire.

Creates an object for each given survey id which includes all statistical results for all questions and question groups (indicators) of the given survey. The SurveyResultRawData object also contains the survey object. Statistical results include: Response count, mean, median, standard deviation, frequency distribution, abstention count, normed mean.

Creates an object for each given survey id which includes all sheet results (raw data) of the given survey. The SurveyRawData object also contains the survey object. The answers to open ended questions can optionally be included and in case of non-anonymous surveys the timestamp and the source of data may be included.

Returns a link of the QR Code for single password based online surveys.

Deletes all log entries from database which are older than the given X days.

Deletes all activities from database which are older than the given X days.

Deletes all deliveries from database which are older than the given X days.

Returns the logo images for all subunits.

Updates the presented subunit. Please note: Child objects of type "User" will not be updated by this method.

Returns a link to the HTML Report of the survey. It is possible to specify whether the link is permanently available or only valid for 20 minutes.

Resets all results (temporary and sent) of a given PSWD and set it back to unused and available. This method is only available for non-anonymous PSWD based surveys.

Returns all system languages as simple list.

Returns all addresses as simple list.

Returns the report configuration for the given id.

Returns a list of all available reports in the system.

Returns a list of result changes for the given survey IDs.

Schedules the given task to run immediately (allowed states: Open=3, Executed=5, Executed with warning=6, Executed with error=7, Deactivated=8). Fault codes: ERR_264 when the task is missing, ERR_265 for a non-runnable status, ERR_266 for invalid date order, ERR_263 on unexpected errors; success returns an empty body.