Version 1.0

Operations:
  1. ActivateOptionalQuestionsForSurveyDetailSource code
  2. ActivateOptionalQuestionsForSurveyAddQuestionsDetailSource code
  3. ActivateOptionalQuestionsForSurveysDetailSource code
  4. CloseSurveyDetailSource code
  5. CreatePdfReportDefinitionDetailSource code
  6. DeleteCourseDetailSource code
  7. DeleteSubunitDetailSource code
  8. DeleteSurveyDetailSource code
  9. DeleteTaskDetailSource code
  10. DeleteUnusedPswdsDetailSource code
  11. DeleteUserDetailSource code
  12. DeleteVolumeLicenseDetailSource code
  13. GetAccessibleSubunitsForSubunitAdminDetailSource code
  14. GetAllFormsDetailSource code
  15. GetAllPeriodsDetailSource code
  16. GetCSVRawDataDetailSource code
  17. GetCourseDetailSource code
  18. GetCourseTypesDetailSource code
  19. GetCoursesByUserIdDetailSource code
  20. GetCustomReportsByFormDetailSource code
  21. GetFormDetailSource code
  22. GetFormByCourseIdAndPeriodIdDetailSource code
  23. GetOnlineSurveyLinkByEmailDetailSource code
  24. GetPDFCoversheetDetailSource code
  25. GetPDFPluginsByFormIdDetailSource code
  26. GetPDFPswdDetailSource code
  27. GetPDFQuestionnaireDetailSource code
  28. GetPDFReportDetailSource code
  29. GetPercentOfCompletedSurveysByParticipantDetailSource code
  30. GetPeriodDetailSource code
  31. GetPswdsByParticipantDetailSource code
  32. GetPswdsByRecipientDetailSource code
  33. GetPswdsBySurveyDetailSource code
  34. GetSPSSRawDataDetailSource code
  35. GetSessionForUserDetailSource code
  36. GetSimpleFormDetailSource code
  37. GetSubunitDetailSource code
  38. GetSubunitsDetailSource code
  39. GetSurveyByIdDetailSource code
  40. GetSurveyRawDataDetailSource code
  41. GetSurveyRawDataByTimeDetailSource code
  42. GetSurveyResultsDetailSource code
  43. GetSurveyTypesDetailSource code
  44. GetSurveysByCourseDetailSource code
  45. GetUserDetailSource code
  46. GetUserVolumeLicensesDetailSource code
  47. GetUsersBySubunitDetailSource code
  48. GetVFDDetailSource code
  49. InsertCentralSurveyDetailSource code
  50. InsertCloseTaskDetailSource code
  51. InsertCourseDetailSource code
  52. InsertFormDetailSource code
  53. InsertInvitationTaskDetailSource code
  54. InsertParticipantsDetailSource code
  55. InsertRemindTaskDetailSource code
  56. InsertResponseRateTaskDetailSource code
  57. InsertSubunitDetailSource code
  58. InsertSurveyNoticeDetailSource code
  59. InsertUserDetailSource code
  60. IsPswdUnusedDetailSource code
  61. ListTasksDetailSource code
  62. OpenSurveyDetailSource code
  63. ReplaceAnswersToOpenQuestionsDetailSource code
  64. RequestTicketDetailSource code
  65. SetupCentralSurveyDetailSource code
  66. UpdateCloseTaskDetailSource code
  67. UpdateCourseDetailSource code
  68. UpdateInvitationTaskDetailSource code
  69. UpdateRemindTaskDetailSource code
  70. UpdateResponseRateTaskDetailSource code
  71. UpdateSurveyDetailSource code
  72. UpdateUserDetailSource code
  73. UploadModulesDetailSource code
  74. UploadSessionsDetailSource code
  75. UploadVolumeLicenseDetailSource code

Operations

    1. ActivateOptionalQuestionsForSurvey
      Description:
      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 cus-tomize “his” 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 “Meldemaskenverfahren” in german.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      ActivateOptionalQuestionsForSurveyRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      SendEmail type boolean
      Mode type int
      Output:
      ActivateOptionalQuestionsForSurveyResponse (soap:body, use = literal)Source code
      Success type boolean
    2. ActivateOptionalQuestionsForSurveyAddQuestions
      Description:
      Same as ActivateOptionalQuestionsForSurvey, but gives the opportunity to add some questiongroups and question directly with the same SOAP-Operation.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      ActivateOptionalQuestionsForSurveyAddQuestionsRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      ItemGroupList type ItemGroupList
      • ItemGroups - optional, unbounded; type ItemGroup
        • ItemGroupId - nillable; type int
        • Position - nillable; type int
        • Title type string
        • Description type string
        • IndicatorDimension - nillable; type int
        • IsText type boolean
        • FontSize - nillable; type int
        • ItemList type ItemList
          • Items - optional, unbounded; type Item
            • ItemId - nillable; type int
            • Position - nillable; type int
            • Title type string
            • ItemCode type string
            • AnswerCount - nillable; type int
            • Type type QuestionTypes - type int with restriction - enum { '0', '2', '4', '6', '8', '10', '14', '1001', '1002', '1003', '1004', '1005', '1006' }
            • Options type StringList
              • Strings - optional, unbounded; type string
            • GraphType type string
            • Abstention type string
            • Orientation type string
            • RowCount - nillable; type int
            • IsMirrored type boolean
            • UseIcr type string
            • ShowDropdown type boolean
            • MaximalAnswers - nillable; type int
            • Alignment type Alignment - type string with restriction - enum { 'right', 'left', 'center', 'justify', '' }
            • Degree - nillable; type int
      Output:
      ActivateOptionalQuestionsForSurveyAddQuestionsResponse (soap:body, use = literal)Source code
      Success type boolean
    3. ActivateOptionalQuestionsForSurveys
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      ActivateOptionalQuestionsForSurveysRequest (soap:header, use = literal, part = Header)Source code
      SurveyIDList type IDList
      • ID - optional, unbounded; type integer
      SendEmail type boolean
      Mode type int
      Output:
      ActivateOptionalQuestionsForSurveysResponse (soap:body, use = literal)Source code
      Success type boolean
    4. CloseSurvey
      Description:
      Closes the survey referenced by its survey ID -> further data collection is not possible for this survey.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      CloseSurveyRequest (soap:header, use = literal, part = Header)Source code
      nSurveyId type int
      Output:
      CloseSurveyResponse (soap:body, use = literal)Source code
      bUpdateSuccess type boolean
    5. CreatePdfReportDefinition
      Description:
      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”.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      CreatePdfReportDefinitionRequest (soap:header, use = literal, part = Header)Source code
      PdfReportDefinitionName type string
      PdfReportDefinitionDescription type string
      PdfReportDefinitionBaseFormId type int
      RelevantQuestions type ItemList
      • Items - optional, unbounded; type Item
        • ItemId - nillable; type int
        • Position - nillable; type int
        • Title type string
        • ItemCode type string
        • AnswerCount - nillable; type int
        • Type type QuestionTypes - type int with restriction - enum { '0', '2', '4', '6', '8', '10', '14', '1001', '1002', '1003', '1004', '1005', '1006' }
        • Options type StringList
          • Strings - optional, unbounded; type string
        • GraphType type string
        • Abstention type string
        • Orientation type string
        • RowCount - nillable; type int
        • IsMirrored type boolean
        • UseIcr type string
        • ShowDropdown type boolean
        • MaximalAnswers - nillable; type int
        • Alignment type Alignment - type string with restriction - enum { 'right', 'left', 'center', 'justify', '' }
        • Degree - nillable; type int
      PdfReportDefinitionRecipients type UserList
      • Users - optional, unbounded; type User
        • m_nId - nillable; type int
        • m_nType - nillable; type int
        • m_sLoginName type string
        • m_sExternalId type string
        • m_sTitle type string
        • m_sFirstName type string
        • m_sSurName type string
        • m_sUnitName type string
        • m_sAddress type string
        • m_sEmail type string
        • m_nFbid - nillable; type int
        • m_nAddressId - nillable; type int
        • m_sPassword type string
        • m_sPhoneNumber type string
        • m_aCourses type CourseList
          • Courses - optional, unbounded; type Course
            • m_nCourseId - nillable; type int
            • m_sProgramOfStudy type string
            • m_sCourseTitle type string
            • m_sRoom type string
            • m_nCourseType - nillable; type int
            • m_sPubCourseId type string
            • m_sExternalId type string
            • m_nCountStud - nillable; type int
            • m_aCustomFieldValues type StringList
              • Strings - optional, unbounded; type string
            • m_nUserId - nillable; type int
            • m_nFbid - nillable; type int
            • m_nPeriodId - nillable; type int
            • m_aoParticipants type PersonList
              • Persons - optional, unbounded; type Person
                • m_nId - nillable; type int
                • m_sTitle type string
                • m_sFirstname type string
                • m_sLastname type string
                • m_sIdentifier type string
                • m_sEmail type string
                • m_nGender - nillable; type int
                • m_sAddress - nillable; type int
                • m_sCustom1 type string
                • m_sCustom2 type string
                • m_sCustom3 type string
            • m_aoSecondaryInstructors type UserList
              • Users - optional, unbounded; type User
                • m_nId - nillable; type int
                • m_nType - nillable; type int
                • m_sLoginName type string
                • m_sExternalId type string
                • m_sTitle type string
                • m_sFirstName type string
                • m_sSurName type string
                • m_sUnitName type string
                • m_sAddress type string
                • m_sEmail type string
                • m_nFbid - nillable; type int
                • m_nAddressId - nillable; type int
                • m_sPassword type string
                • m_sPhoneNumber type string
                • m_aCourses type CourseList
                  • Courses - optional, unbounded; type Course
                    • m_nCourseId - nillable; type int
                    • m_sProgramOfStudy type string
                    • m_sCourseTitle type string
                    • m_sRoom type string
                    • m_nCourseType - nillable; type int
                    • m_sPubCourseId type string
                    • m_sExternalId type string
                    • m_nCountStud - nillable; type int
                    • m_aCustomFieldValues type StringList
                      • Strings - optional, unbounded; type string
                    • m_nUserId - nillable; type int
                    • m_nFbid - nillable; type int
                    • m_nPeriodId - nillable; type int
                    • m_aoParticipants type PersonList
                      • Persons - optional, unbounded; type Person
                        • m_nId - nillable; type int
                        • m_sTitle type string
                        • m_sFirstname type string
                        • m_sLastname type string
                        • m_sIdentifier type string
                        • m_sEmail type string
                        • m_nGender - nillable; type int
                        • m_sAddress - nillable; type int
                        • m_sCustom1 type string
                        • m_sCustom2 type string
                        • m_sCustom3 type string
                    • m_aoSecondaryInstructors type UserList
                      • Users - optional, unbounded; type User
                        • m_nId - nillable; type int
                        • m_nType - nillable; type int
                        • m_sLoginName type string
                        • m_sExternalId type string
                        • m_sTitle type string
                        • m_sFirstName type string
                        • m_sSurName type string
                        • m_sUnitName type string
                        • m_sAddress type string
                        • m_sEmail type string
                        • m_nFbid - nillable; type int
                        • m_nAddressId - nillable; type int
                        • m_sPassword type string
                        • m_sPhoneNumber type string
                        • m_aCourses type CourseList
                          • Courses - optional, unbounded; type Course
                            • m_nCourseId - nillable; type int
                            • m_sProgramOfStudy type string
                            • m_sCourseTitle type string
                            • m_sRoom type string
                            • m_nCourseType - nillable; type int
                            • m_sPubCourseId type string
                            • m_sExternalId type string
                            • m_nCountStud - nillable; type int
                            • m_aCustomFieldValues type StringList
                              • Strings - optional, unbounded; type string
                            • m_nUserId - nillable; type int
                            • m_nFbid - nillable; type int
                            • m_nPeriodId - nillable; type int
                            • m_aoParticipants type PersonList
                              • Persons - optional, unbounded; type Person
                                • m_nId - nillable; type int
                                • m_sTitle type string
                                • m_sFirstname type string
                                • m_sLastname type string
                                • m_sIdentifier type string
                                • m_sEmail type string
                                • m_nGender - nillable; type int
                                • m_sAddress - nillable; type int
                                • m_sCustom1 type string
                                • m_sCustom2 type string
                                • m_sCustom3 type string
                            • m_aoSecondaryInstructors type UserList ... is recursive
                            • m_oSurveyHolder type SurveyHolder
                              • m_aSurveys type SurveyList
                                • Surveys - optional, unbounded; type Survey
                                  • m_nSurveyId - nillable; type int
                                  • m_nState - nillable; type int
                                  • m_sTitle type string
                                  • m_cType type string
                                  • m_nFrmid - nillable; type int
                                  • m_nStuid - nillable; type int
                                  • m_nVerid - nillable; type int
                                  • m_nOpenState - nillable; type int
                                  • m_nFormCount - nillable; type int
                                  • m_nPswdCount - nillable; type int
                                  • m_sLastDataCollectionDate type string
                                  • m_nPageLinkOffset - nillable; type int
                                  • m_sMaskTan type string
                                  • m_nMaskState - nillable; type int
                                  • m_oPeriod type Period
                                    • m_nPeriodId - nillable; type int
                                    • m_sTitel type string
                                    • m_sStartDate type string
                                    • m_sEndDate type string
                    • m_oSurveyHolder type SurveyHolder
                      • m_aSurveys type SurveyList
                        • Surveys - optional, unbounded; type Survey
                          • m_nSurveyId - nillable; type int
                          • m_nState - nillable; type int
                          • m_sTitle type string
                          • m_cType type string
                          • m_nFrmid - nillable; type int
                          • m_nStuid - nillable; type int
                          • m_nVerid - nillable; type int
                          • m_nOpenState - nillable; type int
                          • m_nFormCount - nillable; type int
                          • m_nPswdCount - nillable; type int
                          • m_sLastDataCollectionDate type string
                          • m_nPageLinkOffset - nillable; type int
                          • m_sMaskTan type string
                          • m_nMaskState - nillable; type int
                          • m_oPeriod type Period
                            • m_nPeriodId - nillable; type int
                            • m_sTitel type string
                            • m_sStartDate type string
                            • m_sEndDate type string
            • m_oSurveyHolder type SurveyHolder
              • m_aSurveys type SurveyList
                • Surveys - optional, unbounded; type Survey
                  • m_nSurveyId - nillable; type int
                  • m_nState - nillable; type int
                  • m_sTitle type string
                  • m_cType type string
                  • m_nFrmid - nillable; type int
                  • m_nStuid - nillable; type int
                  • m_nVerid - nillable; type int
                  • m_nOpenState - nillable; type int
                  • m_nFormCount - nillable; type int
                  • m_nPswdCount - nillable; type int
                  • m_sLastDataCollectionDate type string
                  • m_nPageLinkOffset - nillable; type int
                  • m_sMaskTan type string
                  • m_nMaskState - nillable; type int
                  • m_oPeriod type Period
                    • m_nPeriodId - nillable; type int
                    • m_sTitel type string
                    • m_sStartDate type string
                    • m_sEndDate type string
      PdfReportDefinitionCreationMode type PdfDefinitionCreationMode - type string with restriction - enum { 'INCLUSIVE', 'EXCLUSIVE' }
      PdfReportDefinitionBaseReportId type int
      Output:
      CreatePdfReportDefinitionResponse (soap:body, use = literal)Source code
      CreatedPdfReportDefinitionId type int
    6. DeleteCourse
      Description:
      Deletes a course including all (!) child elements (surveys, survey results, etc.).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      DeleteCourseRequest (soap:header, use = literal, part = Header)Source code
      CourseId type string
      IdType type CourseIdType - type string with restriction - enum { 'INTERNAL', 'PUBLIC', 'EXTERNAL' }
      Output:
      DeleteCourseResponse (soap:body, use = literal)Source code
      Success type boolean
    7. DeleteSubunit
      Description:
      Deletes a subunit including all (!) child elements (users, courses, surveys, survey results, etc.).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      DeleteSubunitRequest (soap:header, use = literal, part = Header)Source code
      SubunitId type string
      IdType type SubunitIdType - type string with restriction - enum { 'INTERNAL', 'NAME' }
      Output:
      DeleteSubunitResponse (soap:body, use = literal)Source code
      Success type boolean
    8. DeleteSurvey
      Description:
      Deletes a survey including all (!) child elements (survey results, etc.).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      DeleteSurveyRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      Output:
      DeleteSurveyResponse (soap:body, use = literal)Source code
      Success type boolean
    9. DeleteTask
      Description:
      Remove a Task from the database.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      DeleteTaskRequest (soap:header, use = literal, part = Header)Source code
      TaskId type int
      Output:
      DeleteTaskResponse (soap:body, use = literal)Source code
      Success type boolean
    10. DeleteUnusedPswds
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      DeleteUnusedPswdsRequest (soap:header, use = literal, part = Header)Source code
      ObjectList type OnlineCodeList
      • OnlineCodes - optional, unbounded; type OnlineCode
        • m_sOnlineCode type string
        • m_nCodeType - nillable; type int
        • m_nSurveyId - nillable; type int
        • m_sRecipientMailAddress type string
        • m_sDirectOnlineLink type string
      Output:
      DeleteUnusedPswdsResponse (soap:body, use = literal)Source code
      ObjectList type OnlineCodeList
      • OnlineCodes - optional, unbounded; type OnlineCode
        • m_sOnlineCode type string
        • m_nCodeType - nillable; type int
        • m_nSurveyId - nillable; type int
        • m_sRecipientMailAddress type string
        • m_sDirectOnlineLink type string
    11. DeleteUser
      Description:
      Deletes a user including all (!) child elements (courses, surveys, survey results, etc.).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      DeleteUserRequest (soap:header, use = literal, part = Header)Source code
      UserId type string
      IdType type UserIdType - type string with restriction - enum { 'INTERNAL', 'LOGIN', 'EXTERNAL' }
      Output:
      DeleteUserResponse (soap:body, use = literal)Source code
      Success type boolean
    12. DeleteVolumeLicense
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      DeleteVolumeLicenseRequest (soap:header, use = literal, part = Header)Source code
      UserId type int
      LicenseId type int
      LicenseKey type string
      Output:
      DeleteVolumeLicenseResponse (soap:body, use = literal)Source code
      deleteStatus type boolean
    13. GetAccessibleSubunitsForSubunitAdmin
      Description:
      Returns all accessible subunits for the presented user id (only for subunit administrators).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetAccessibleSubunitsForSubunitAdminRequest (soap:header, use = literal, part = Header)Source code
      nUserId type int
      Output:
      GetAccessibleSubunitsForSubunitAdminResponse (soap:body, use = literal)Source code
      UnitList type UnitList
      • Units - optional, unbounded; type Unit
        • m_nId - nillable; type int
        • m_sName type string
        • m_nPublicUnitNumber - nillable; type int
        • m_nImageAccess - nillable; type int
        • m_aUsers type UserList
          • Users - optional, unbounded; type User
            • m_nId - nillable; type int
            • m_nType - nillable; type int
            • m_sLoginName type string
            • m_sExternalId type string
            • m_sTitle type string
            • m_sFirstName type string
            • m_sSurName type string
            • m_sUnitName type string
            • m_sAddress type string
            • m_sEmail type string
            • m_nFbid - nillable; type int
            • m_nAddressId - nillable; type int
            • m_sPassword type string
            • m_sPhoneNumber type string
            • m_aCourses type CourseList
              • Courses - optional, unbounded; type Course
                • m_nCourseId - nillable; type int
                • m_sProgramOfStudy type string
                • m_sCourseTitle type string
                • m_sRoom type string
                • m_nCourseType - nillable; type int
                • m_sPubCourseId type string
                • m_sExternalId type string
                • m_nCountStud - nillable; type int
                • m_aCustomFieldValues type StringList
                  • Strings - optional, unbounded; type string
                • m_nUserId - nillable; type int
                • m_nFbid - nillable; type int
                • m_nPeriodId - nillable; type int
                • m_aoParticipants type PersonList
                  • Persons - optional, unbounded; type Person
                    • m_nId - nillable; type int
                    • m_sTitle type string
                    • m_sFirstname type string
                    • m_sLastname type string
                    • m_sIdentifier type string
                    • m_sEmail type string
                    • m_nGender - nillable; type int
                    • m_sAddress - nillable; type int
                    • m_sCustom1 type string
                    • m_sCustom2 type string
                    • m_sCustom3 type string
                • m_aoSecondaryInstructors type UserList
                  • Users - optional, unbounded; type User
                    • m_nId - nillable; type int
                    • m_nType - nillable; type int
                    • m_sLoginName type string
                    • m_sExternalId type string
                    • m_sTitle type string
                    • m_sFirstName type string
                    • m_sSurName type string
                    • m_sUnitName type string
                    • m_sAddress type string
                    • m_sEmail type string
                    • m_nFbid - nillable; type int
                    • m_nAddressId - nillable; type int
                    • m_sPassword type string
                    • m_sPhoneNumber type string
                    • m_aCourses type CourseList
                      • Courses - optional, unbounded; type Course
                        • m_nCourseId - nillable; type int
                        • m_sProgramOfStudy type string
                        • m_sCourseTitle type string
                        • m_sRoom type string
                        • m_nCourseType - nillable; type int
                        • m_sPubCourseId type string
                        • m_sExternalId type string
                        • m_nCountStud - nillable; type int
                        • m_aCustomFieldValues type StringList
                          • Strings - optional, unbounded; type string
                        • m_nUserId - nillable; type int
                        • m_nFbid - nillable; type int
                        • m_nPeriodId - nillable; type int
                        • m_aoParticipants type PersonList
                          • Persons - optional, unbounded; type Person
                            • m_nId - nillable; type int
                            • m_sTitle type string
                            • m_sFirstname type string
                            • m_sLastname type string
                            • m_sIdentifier type string
                            • m_sEmail type string
                            • m_nGender - nillable; type int
                            • m_sAddress - nillable; type int
                            • m_sCustom1 type string
                            • m_sCustom2 type string
                            • m_sCustom3 type string
                        • m_aoSecondaryInstructors type UserList
                          • Users - optional, unbounded; type User
                            • m_nId - nillable; type int
                            • m_nType - nillable; type int
                            • m_sLoginName type string
                            • m_sExternalId type string
                            • m_sTitle type string
                            • m_sFirstName type string
                            • m_sSurName type string
                            • m_sUnitName type string
                            • m_sAddress type string
                            • m_sEmail type string
                            • m_nFbid - nillable; type int
                            • m_nAddressId - nillable; type int
                            • m_sPassword type string
                            • m_sPhoneNumber type string
                            • m_aCourses type CourseList
                              • Courses - optional, unbounded; type Course
                                • m_nCourseId - nillable; type int
                                • m_sProgramOfStudy type string
                                • m_sCourseTitle type string
                                • m_sRoom type string
                                • m_nCourseType - nillable; type int
                                • m_sPubCourseId type string
                                • m_sExternalId type string
                                • m_nCountStud - nillable; type int
                                • m_aCustomFieldValues type StringList
                                  • Strings - optional, unbounded; type string
                                • m_nUserId - nillable; type int
                                • m_nFbid - nillable; type int
                                • m_nPeriodId - nillable; type int
                                • m_aoParticipants type PersonList
                                  • Persons - optional, unbounded; type Person
                                    • m_nId - nillable; type int
                                    • m_sTitle type string
                                    • m_sFirstname type string
                                    • m_sLastname type string
                                    • m_sIdentifier type string
                                    • m_sEmail type string
                                    • m_nGender - nillable; type int
                                    • m_sAddress - nillable; type int
                                    • m_sCustom1 type string
                                    • m_sCustom2 type string
                                    • m_sCustom3 type string
                                • m_aoSecondaryInstructors type UserList ... is recursive
                                • m_oSurveyHolder type SurveyHolder
                                  • m_aSurveys type SurveyList
                                    • Surveys - optional, unbounded; type Survey
                                      • m_nSurveyId - nillable; type int
                                      • m_nState - nillable; type int
                                      • m_sTitle type string
                                      • m_cType type string
                                      • m_nFrmid - nillable; type int
                                      • m_nStuid - nillable; type int
                                      • m_nVerid - nillable; type int
                                      • m_nOpenState - nillable; type int
                                      • m_nFormCount - nillable; type int
                                      • m_nPswdCount - nillable; type int
                                      • m_sLastDataCollectionDate type string
                                      • m_nPageLinkOffset - nillable; type int
                                      • m_sMaskTan type string
                                      • m_nMaskState - nillable; type int
                                      • m_oPeriod type Period
                                        • m_nPeriodId - nillable; type int
                                        • m_sTitel type string
                                        • m_sStartDate type string
                                        • m_sEndDate type string
                        • m_oSurveyHolder type SurveyHolder
                          • m_aSurveys type SurveyList
                            • Surveys - optional, unbounded; type Survey
                              • m_nSurveyId - nillable; type int
                              • m_nState - nillable; type int
                              • m_sTitle type string
                              • m_cType type string
                              • m_nFrmid - nillable; type int
                              • m_nStuid - nillable; type int
                              • m_nVerid - nillable; type int
                              • m_nOpenState - nillable; type int
                              • m_nFormCount - nillable; type int
                              • m_nPswdCount - nillable; type int
                              • m_sLastDataCollectionDate type string
                              • m_nPageLinkOffset - nillable; type int
                              • m_sMaskTan type string
                              • m_nMaskState - nillable; type int
                              • m_oPeriod type Period
                                • m_nPeriodId - nillable; type int
                                • m_sTitel type string
                                • m_sStartDate type string
                                • m_sEndDate type string
                • m_oSurveyHolder type SurveyHolder
                  • m_aSurveys type SurveyList
                    • Surveys - optional, unbounded; type Survey
                      • m_nSurveyId - nillable; type int
                      • m_nState - nillable; type int
                      • m_sTitle type string
                      • m_cType type string
                      • m_nFrmid - nillable; type int
                      • m_nStuid - nillable; type int
                      • m_nVerid - nillable; type int
                      • m_nOpenState - nillable; type int
                      • m_nFormCount - nillable; type int
                      • m_nPswdCount - nillable; type int
                      • m_sLastDataCollectionDate type string
                      • m_nPageLinkOffset - nillable; type int
                      • m_sMaskTan type string
                      • m_nMaskState - nillable; type int
                      • m_oPeriod type Period
                        • m_nPeriodId - nillable; type int
                        • m_sTitel type string
                        • m_sStartDate type string
                        • m_sEndDate type string
    14. GetAllForms
      Description:
      Returns all active forms of all users stored in the system.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetAllFormsRequest (soap:header, use = literal, part = Header)Source code
      IncludeCustomReports type boolean
      Output:
      GetAllFormsResponse (soap:body, use = literal)Source code
      FormList type SimpleFormList
      • SimpleForms - optional, unbounded; type SimpleForm
        • ID - nillable; type int
        • Name type string
        • OwnerID - nillable; type int
        • FormEngine - nillable; type int
        • CustomReportList type CustomReportList
          • CustomReports - optional, unbounded; type CustomReport
            • ID - nillable; type int
            • Name type string
    15. GetAllPeriods
      Description:
      Returns all defined evaluation periods in the system, sorted by date.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetAllPeriodsRequest (soap:header, use = literal, part = Header)Source code
      Output:
      GetAllPeriodsResponse (soap:body, use = literal)Source code
      PeriodList type PeriodList
      • Periods - optional, unbounded; type Period
        • m_nPeriodId - nillable; type int
        • m_sTitel type string
        • m_sStartDate type string
        • m_sEndDate type string
    16. GetCSVRawData
      Description:
      Creates the CSV export file of the survey and returns the link to the file.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetCSVRawDataRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      Output:
      GetCSVRawDataResponse (soap:body, use = literal)Source code
      HyperLink type string
    17. GetCourse
      Description:
      Returns the course, referenced by the internal the system 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”.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetCourseRequest (soap:header, use = literal, part = Header)Source code
      CourseId type string
      IdType type CourseIdType - type string with restriction - enum { 'INTERNAL', 'PUBLIC', 'EXTERNAL' }
      IncludeSurveys type boolean
      IncludeParticipants type boolean
      Output:
      GetCourseResponse (soap:body, use = literal)Source code
      Course type Course
      • m_nCourseId - nillable; type int
      • m_sProgramOfStudy type string
      • m_sCourseTitle type string
      • m_sRoom type string
      • m_nCourseType - nillable; type int
      • m_sPubCourseId type string
      • m_sExternalId type string
      • m_nCountStud - nillable; type int
      • m_aCustomFieldValues type StringList
        • Strings - optional, unbounded; type string
      • m_nUserId - nillable; type int
      • m_nFbid - nillable; type int
      • m_nPeriodId - nillable; type int
      • m_aoParticipants type PersonList
        • Persons - optional, unbounded; type Person
          • m_nId - nillable; type int
          • m_sTitle type string
          • m_sFirstname type string
          • m_sLastname type string
          • m_sIdentifier type string
          • m_sEmail type string
          • m_nGender - nillable; type int
          • m_sAddress - nillable; type int
          • m_sCustom1 type string
          • m_sCustom2 type string
          • m_sCustom3 type string
      • m_aoSecondaryInstructors type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course ... is recursive
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
      • m_oSurveyHolder type SurveyHolder
        • m_aSurveys type SurveyList
          • Surveys - optional, unbounded; type Survey
            • m_nSurveyId - nillable; type int
            • m_nState - nillable; type int
            • m_sTitle type string
            • m_cType type string
            • m_nFrmid - nillable; type int
            • m_nStuid - nillable; type int
            • m_nVerid - nillable; type int
            • m_nOpenState - nillable; type int
            • m_nFormCount - nillable; type int
            • m_nPswdCount - nillable; type int
            • m_sLastDataCollectionDate type string
            • m_nPageLinkOffset - nillable; type int
            • m_sMaskTan type string
            • m_nMaskState - nillable; type int
            • m_oPeriod type Period
              • m_nPeriodId - nillable; type int
              • m_sTitel type string
              • m_sStartDate type string
              • m_sEndDate type string
    18. GetCourseTypes
      Description:
      Returns a list of course types. Optional only course types which are used for module evaluation.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetCourseTypesRequest (soap:header, use = literal, part = Header)Source code
      OnlyModuleCourseTypes type boolean
      Output:
      GetCourseTypesResponse (soap:body, use = literal)Source code
      CourseTypeList type CourseTypeList
      • CourseTypes - optional, unbounded; type CourseType
        • m_nCourseTypeId - nillable; type int
        • m_sName type string
        • m_nModuleFrmId - nillable; type int
    19. GetCoursesByUserId
      Description:
      Returns all courses for the specified the system user (ID). Returns an error, if the user has no courses.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetCoursesByUserIdRequest (soap:header, use = literal, part = Header)Source code
      nUserId type int
      Output:
      GetCoursesByUserIdResponse (soap:body, use = literal)Source code
      CourseList type CourseList
      • Courses - optional, unbounded; type Course
        • m_nCourseId - nillable; type int
        • m_sProgramOfStudy type string
        • m_sCourseTitle type string
        • m_sRoom type string
        • m_nCourseType - nillable; type int
        • m_sPubCourseId type string
        • m_sExternalId type string
        • m_nCountStud - nillable; type int
        • m_aCustomFieldValues type StringList
          • Strings - optional, unbounded; type string
        • m_nUserId - nillable; type int
        • m_nFbid - nillable; type int
        • m_nPeriodId - nillable; type int
        • m_aoParticipants type PersonList
          • Persons - optional, unbounded; type Person
            • m_nId - nillable; type int
            • m_sTitle type string
            • m_sFirstname type string
            • m_sLastname type string
            • m_sIdentifier type string
            • m_sEmail type string
            • m_nGender - nillable; type int
            • m_sAddress - nillable; type int
            • m_sCustom1 type string
            • m_sCustom2 type string
            • m_sCustom3 type string
        • m_aoSecondaryInstructors type UserList
          • Users - optional, unbounded; type User
            • m_nId - nillable; type int
            • m_nType - nillable; type int
            • m_sLoginName type string
            • m_sExternalId type string
            • m_sTitle type string
            • m_sFirstName type string
            • m_sSurName type string
            • m_sUnitName type string
            • m_sAddress type string
            • m_sEmail type string
            • m_nFbid - nillable; type int
            • m_nAddressId - nillable; type int
            • m_sPassword type string
            • m_sPhoneNumber type string
            • m_aCourses type CourseList
              • Courses - optional, unbounded; type Course
                • m_nCourseId - nillable; type int
                • m_sProgramOfStudy type string
                • m_sCourseTitle type string
                • m_sRoom type string
                • m_nCourseType - nillable; type int
                • m_sPubCourseId type string
                • m_sExternalId type string
                • m_nCountStud - nillable; type int
                • m_aCustomFieldValues type StringList
                  • Strings - optional, unbounded; type string
                • m_nUserId - nillable; type int
                • m_nFbid - nillable; type int
                • m_nPeriodId - nillable; type int
                • m_aoParticipants type PersonList
                  • Persons - optional, unbounded; type Person
                    • m_nId - nillable; type int
                    • m_sTitle type string
                    • m_sFirstname type string
                    • m_sLastname type string
                    • m_sIdentifier type string
                    • m_sEmail type string
                    • m_nGender - nillable; type int
                    • m_sAddress - nillable; type int
                    • m_sCustom1 type string
                    • m_sCustom2 type string
                    • m_sCustom3 type string
                • m_aoSecondaryInstructors type UserList
                  • Users - optional, unbounded; type User
                    • m_nId - nillable; type int
                    • m_nType - nillable; type int
                    • m_sLoginName type string
                    • m_sExternalId type string
                    • m_sTitle type string
                    • m_sFirstName type string
                    • m_sSurName type string
                    • m_sUnitName type string
                    • m_sAddress type string
                    • m_sEmail type string
                    • m_nFbid - nillable; type int
                    • m_nAddressId - nillable; type int
                    • m_sPassword type string
                    • m_sPhoneNumber type string
                    • m_aCourses type CourseList
                      • Courses - optional, unbounded; type Course
                        • m_nCourseId - nillable; type int
                        • m_sProgramOfStudy type string
                        • m_sCourseTitle type string
                        • m_sRoom type string
                        • m_nCourseType - nillable; type int
                        • m_sPubCourseId type string
                        • m_sExternalId type string
                        • m_nCountStud - nillable; type int
                        • m_aCustomFieldValues type StringList
                          • Strings - optional, unbounded; type string
                        • m_nUserId - nillable; type int
                        • m_nFbid - nillable; type int
                        • m_nPeriodId - nillable; type int
                        • m_aoParticipants type PersonList
                          • Persons - optional, unbounded; type Person
                            • m_nId - nillable; type int
                            • m_sTitle type string
                            • m_sFirstname type string
                            • m_sLastname type string
                            • m_sIdentifier type string
                            • m_sEmail type string
                            • m_nGender - nillable; type int
                            • m_sAddress - nillable; type int
                            • m_sCustom1 type string
                            • m_sCustom2 type string
                            • m_sCustom3 type string
                        • m_aoSecondaryInstructors type UserList
                          • Users - optional, unbounded; type User
                            • m_nId - nillable; type int
                            • m_nType - nillable; type int
                            • m_sLoginName type string
                            • m_sExternalId type string
                            • m_sTitle type string
                            • m_sFirstName type string
                            • m_sSurName type string
                            • m_sUnitName type string
                            • m_sAddress type string
                            • m_sEmail type string
                            • m_nFbid - nillable; type int
                            • m_nAddressId - nillable; type int
                            • m_sPassword type string
                            • m_sPhoneNumber type string
                            • m_aCourses type CourseList ... is recursive
                        • m_oSurveyHolder type SurveyHolder
                          • m_aSurveys type SurveyList
                            • Surveys - optional, unbounded; type Survey
                              • m_nSurveyId - nillable; type int
                              • m_nState - nillable; type int
                              • m_sTitle type string
                              • m_cType type string
                              • m_nFrmid - nillable; type int
                              • m_nStuid - nillable; type int
                              • m_nVerid - nillable; type int
                              • m_nOpenState - nillable; type int
                              • m_nFormCount - nillable; type int
                              • m_nPswdCount - nillable; type int
                              • m_sLastDataCollectionDate type string
                              • m_nPageLinkOffset - nillable; type int
                              • m_sMaskTan type string
                              • m_nMaskState - nillable; type int
                              • m_oPeriod type Period
                                • m_nPeriodId - nillable; type int
                                • m_sTitel type string
                                • m_sStartDate type string
                                • m_sEndDate type string
                • m_oSurveyHolder type SurveyHolder
                  • m_aSurveys type SurveyList
                    • Surveys - optional, unbounded; type Survey
                      • m_nSurveyId - nillable; type int
                      • m_nState - nillable; type int
                      • m_sTitle type string
                      • m_cType type string
                      • m_nFrmid - nillable; type int
                      • m_nStuid - nillable; type int
                      • m_nVerid - nillable; type int
                      • m_nOpenState - nillable; type int
                      • m_nFormCount - nillable; type int
                      • m_nPswdCount - nillable; type int
                      • m_sLastDataCollectionDate type string
                      • m_nPageLinkOffset - nillable; type int
                      • m_sMaskTan type string
                      • m_nMaskState - nillable; type int
                      • m_oPeriod type Period
                        • m_nPeriodId - nillable; type int
                        • m_sTitel type string
                        • m_sStartDate type string
                        • m_sEndDate type string
        • m_oSurveyHolder type SurveyHolder
          • m_aSurveys type SurveyList
            • Surveys - optional, unbounded; type Survey
              • m_nSurveyId - nillable; type int
              • m_nState - nillable; type int
              • m_sTitle type string
              • m_cType type string
              • m_nFrmid - nillable; type int
              • m_nStuid - nillable; type int
              • m_nVerid - nillable; type int
              • m_nOpenState - nillable; type int
              • m_nFormCount - nillable; type int
              • m_nPswdCount - nillable; type int
              • m_sLastDataCollectionDate type string
              • m_nPageLinkOffset - nillable; type int
              • m_sMaskTan type string
              • m_nMaskState - nillable; type int
              • m_oPeriod type Period
                • m_nPeriodId - nillable; type int
                • m_sTitel type string
                • m_sStartDate type string
                • m_sEndDate type string
    20. GetCustomReportsByForm
      Description:
      The operation returns a list of available PDF report definitions of a given form.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetCustomReportsByFormRequest (soap:header, use = literal, part = Header)Source code
      FormId type string
      IdType type FormIdType - type string with restriction - enum { 'INTERNAL', 'FORMNAME' }
      Output:
      GetCustomReportsByFormResponse (soap:body, use = literal)Source code
      CustomReportList type CustomReportList
      • CustomReports - optional, unbounded; type CustomReport
        • ID - nillable; type int
        • Name type string
    21. GetForm
      Description:
      Returns the questionnaire/form referenced by its internal the system 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 3rd parameter is true, only questions will be returned and no layout elements like free text, horizontal lines, etc.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetFormRequest (soap:header, use = literal, part = Header)Source code
      FormId type string
      IdType type FormIdType - type string with restriction - enum { 'INTERNAL', 'FORMNAME' }
      IncludeOnlyQuestions type boolean
      Output:
      GetFormResponse (soap:body, use = literal)Source code
      VFForm type VFForm
      • FormId - nillable; type int
      • FormName type string
      • FormTitle type string
      • OwnerId - nillable; type int
      • PaperFormat type string
      • ShowNumeration type boolean
      • AnswerBoxSize - nillable; type int
      • MaxPages - nillable; type int
      • MaxQuestions - nillable; type int
      • FontFamily type string
      • FontSize - nillable; type int
      • RowHeight - nillable; type int
      • CreateDate type string
      • IsActivated type boolean
      • ResultAccess type boolean
      • HeadLineUpperLeft type string
      • HeadLineLowerLeft type string
      • HeadLineUpperRight type string
      • HeadLineLowerRight type string
      • HeadLineMark type string
      • HeadLineCorrection type string
      • ItemGroupList type ItemGroupList
        • ItemGroups - optional, unbounded; type ItemGroup
          • ItemGroupId - nillable; type int
          • Position - nillable; type int
          • Title type string
          • Description type string
          • IndicatorDimension - nillable; type int
          • IsText type boolean
          • FontSize - nillable; type int
          • ItemList type ItemList
            • Items - optional, unbounded; type Item
              • ItemId - nillable; type int
              • Position - nillable; type int
              • Title type string
              • ItemCode type string
              • AnswerCount - nillable; type int
              • Type type QuestionTypes - type int with restriction - enum { '0', '2', '4', '6', '8', '10', '14', '1001', '1002', '1003', '1004', '1005', '1006' }
              • Options type StringList
                • Strings - optional, unbounded; type string
              • GraphType type string
              • Abstention type string
              • Orientation type string
              • RowCount - nillable; type int
              • IsMirrored type boolean
              • UseIcr type string
              • ShowDropdown type boolean
              • MaximalAnswers - nillable; type int
              • Alignment type Alignment - type string with restriction - enum { 'right', 'left', 'center', 'justify', '' }
              • Degree - nillable; type int
      • HeaderLineCount - nillable; type int
      • AdditionalHeaderLineList type AdditionalHeaderLineList
        • AdditionalHeaderLines - optional; type AdditionalHeaderLine
          • LeftFieldContent - nillable; type string
          • RightFieldContent - nillable; type string
    22. GetFormByCourseIdAndPeriodId
      Description:
      Forms can be assigned to specific course types and periods in the system. Use this transaction to get the "approved" forms for a course.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetFormByCourseIdAndPeriodIdRequest (soap:header, use = literal, part = Header)Source code
      nCourseId type int
      nPeriodId type int
      Output:
      GetFormByCourseIdAndPeriodIdResponse (soap:body, use = literal)Source code
      FormList type SimpleFormList
      • SimpleForms - optional, unbounded; type SimpleForm
        • ID - nillable; type int
        • Name type string
        • OwnerID - nillable; type int
        • FormEngine - nillable; type int
        • CustomReportList type CustomReportList
          • CustomReports - optional, unbounded; type CustomReport
            • ID - nillable; type int
            • Name type string
    23. GetOnlineSurveyLinkByEmail
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetOnlineSurveyLinkByEmailRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type integer
      EmailAddress type string
      AddRecipientToSurvey type boolean
      AutoIncreasePSWDCount type boolean
      Output:
      GetOnlineSurveyLinkByEmailResponse (soap:body, use = literal)Source code
      OnlineSurveyLink type string
    24. GetPDFCoversheet
      Description:
      Creates a PDF coversheet and returns the hyperlink to the file. The coversheet is personalized for the survey and can be used for scanning (co-versheet procedure).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPDFCoversheetRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      Output:
      GetPDFCoversheetResponse (soap:body, use = literal)Source code
      HyperLink type string
    25. GetPDFPluginsByFormId
      Description:
      This transaction returns a list of all available PDF Plugins for the presented form ID.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPDFPluginsByFormIdRequest (soap:header, use = literal, part = Header)Source code
      FormId type int
      Output:
      GetPDFPluginsByFormIdResponse (soap:body, use = literal)Source code
      PDFPluginContainer type PDFPluginContainer
      • m_aPluginArray type PDFPluginList
        • PDFPlugins - unbounded; type PDFPlugin
          • m_nPluginId - nillable; type int
          • m_sTitle type string
    26. GetPDFPswd
      Description:
      Creates a PDF with the PSWDs (cards) and returns the hyperlink to the file.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPDFPswdRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      Output:
      GetPDFPswdResponse (soap:body, use = literal)Source code
      HyperLink type string
    27. GetPDFQuestionnaire
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPDFQuestionnaireRequest (soap:header, use = literal, part = Header)Source code
      FormId type int
      SurveyId type int
      SerialPrint type boolean
      Output:
      GetPDFQuestionnaireResponse (soap:body, use = literal)Source code
      HyperLink type string
    28. GetPDFReport
      Description:
      Creates the PDF report for a survey and returns a hyperlink to the document.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPDFReportRequest (soap:header, use = literal, part = Header)Source code
      nSurveyId type int
      nUserId type int
      nCustomPDFId type int
      nLanguageID type int
      Output:
      GetPDFReportResponse (soap:body, use = literal)Source code
      ReportLink type string
    29. GetPercentOfCompletedSurveysByParticipant
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPercentOfCompletedSurveysByParticipantRequest (soap:header, use = literal, part = Header)Source code
      UserMailAddress type string
      StartDate type string
      EndDate type string
      SubunitId type string
      IdType type SubunitIdType - type string with restriction - enum { 'INTERNAL', 'NAME' }
      Output:
      GetPercentOfCompletedSurveysByParticipantResponse (soap:body, use = literal)Source code
      Percentage type int
    30. GetPeriod
      Description:
      Returns a period referenced by its the system period ID, period name or period date (format YYYY-MM-DD).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPeriodRequest (soap:header, use = literal, part = Header)Source code
      sPeriodId type string
      sPeriodIdType type PeriodIdType - type string with restriction - enum { 'INTERNAL', 'PERIODNAME', 'PERIODDATE' }
      Output:
      GetPeriodResponse (soap:body, use = literal)Source code
      Period type Period
      • m_nPeriodId - nillable; type int
      • m_sTitel type string
      • m_sStartDate type string
      • m_sEndDate type string
    31. GetPswdsByParticipant
      Description:
      Returns the online access codes (PSWD) for the shown email address and course ID in the period of the current date.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPswdsByParticipantRequest (soap:header, use = literal, part = Header)Source code
      UserMailAddress type string
      CourseCode type string
      Output:
      GetPswdsByParticipantResponse (soap:body, use = literal)Source code
      OnlineSurveyKeys type OnlineSurveyKeyList
      • OnlineSurveyKeys - optional, unbounded; type OnlineSurveyKey
        • CourseId type string
        • TransactionNumber type string
        • CourseName type string
        • Instructor type Instructor
          • InstructorUid type string
          • InstructorLogin type string
          • FirstName - optional; type string
          • LastName type string
          • Title - optional; type string
          • Gender - optional; type string
          • Email - optional; type string
          • Phone - optional; type string
          • Language - optional; type string
          • IsActiveUser - optional; type string
    32. GetPswdsByRecipient
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPswdsByRecipientRequest (soap:header, use = literal, part = Header)Source code
      UserMailAddress type string
      Output:
      GetPswdsByRecipientResponse (soap:body, use = literal)Source code
      ObjectList type OnlineCodeList
      • OnlineCodes - optional, unbounded; type OnlineCode
        • m_sOnlineCode type string
        • m_nCodeType - nillable; type int
        • m_nSurveyId - nillable; type int
        • m_sRecipientMailAddress type string
        • m_sDirectOnlineLink type string
    33. GetPswdsBySurvey
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetPswdsBySurveyRequest (soap:header, use = literal, part = Header)Source code
      nSurveyId type int
      nPswdCount type int
      Output:
      GetPswdsBySurveyResponse (soap:body, use = literal)Source code
      ObjectList type OnlineCodeList
      • OnlineCodes - optional, unbounded; type OnlineCode
        • m_sOnlineCode type string
        • m_nCodeType - nillable; type int
        • m_nSurveyId - nillable; type int
        • m_sRecipientMailAddress type string
        • m_sDirectOnlineLink type string
    34. GetSPSSRawData
      Description:
      Creates the SPSS export file of the survey and returns the link to the file.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSPSSRawDataRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      Output:
      GetSPSSRawDataResponse (soap:body, use = literal)Source code
      HyperLink type string
    35. GetSessionForUser
      Description:
      Returns a session for a given username and password. The session object contains the SessionId, the Server IP and the user start page. This method can be used to authenticate users via SOAP.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSessionForUserRequest (soap:header, use = literal, part = Header)Source code
      UserId type string
      IdType type UserIdType - type string with restriction - enum { 'INTERNAL', 'LOGIN', 'EXTERNAL' }
      Output:
      GetSessionForUserResponse (soap:body, use = literal)Source code
      SessionModel type UserSession
      • SessionId type string
      • ServerIp type string
      • UserStartPage type string
    36. GetSimpleForm
      Description:
      Returns a simplified version of the form referenced to by the formid.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSimpleFormRequest (soap:header, use = literal, part = Header)Source code
      FormId type string
      IdType type FormIdType - type string with restriction - enum { 'INTERNAL', 'FORMNAME' }
      IncludeCustomReports type boolean
      Output:
      GetSimpleFormResponse (soap:body, use = literal)Source code
      SimpleForm type SimpleForm
      • ID - nillable; type int
      • Name type string
      • OwnerID - nillable; type int
      • FormEngine - nillable; type int
      • CustomReportList type CustomReportList
        • CustomReports - optional, unbounded; type CustomReport
          • ID - nillable; type int
          • Name type string
    37. GetSubunit
      Description:
      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 con-tain child objects of the type “User”.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSubunitRequest (soap:header, use = literal, part = Header)Source code
      SubunitId type string
      IdType type SubunitIdType - type string with restriction - enum { 'INTERNAL', 'NAME' }
      IncludeInstructors type boolean
      Output:
      GetSubunitResponse (soap:body, use = literal)Source code
      Unit type Unit
      • m_nId - nillable; type int
      • m_sName type string
      • m_nPublicUnitNumber - nillable; type int
      • m_nImageAccess - nillable; type int
      • m_aUsers type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course
                              • m_nCourseId - nillable; type int
                              • m_sProgramOfStudy type string
                              • m_sCourseTitle type string
                              • m_sRoom type string
                              • m_nCourseType - nillable; type int
                              • m_sPubCourseId type string
                              • m_sExternalId type string
                              • m_nCountStud - nillable; type int
                              • m_aCustomFieldValues type StringList
                                • Strings - optional, unbounded; type string
                              • m_nUserId - nillable; type int
                              • m_nFbid - nillable; type int
                              • m_nPeriodId - nillable; type int
                              • m_aoParticipants type PersonList
                                • Persons - optional, unbounded; type Person
                                  • m_nId - nillable; type int
                                  • m_sTitle type string
                                  • m_sFirstname type string
                                  • m_sLastname type string
                                  • m_sIdentifier type string
                                  • m_sEmail type string
                                  • m_nGender - nillable; type int
                                  • m_sAddress - nillable; type int
                                  • m_sCustom1 type string
                                  • m_sCustom2 type string
                                  • m_sCustom3 type string
                              • m_aoSecondaryInstructors type UserList ... is recursive
                              • m_oSurveyHolder type SurveyHolder
                                • m_aSurveys type SurveyList
                                  • Surveys - optional, unbounded; type Survey
                                    • m_nSurveyId - nillable; type int
                                    • m_nState - nillable; type int
                                    • m_sTitle type string
                                    • m_cType type string
                                    • m_nFrmid - nillable; type int
                                    • m_nStuid - nillable; type int
                                    • m_nVerid - nillable; type int
                                    • m_nOpenState - nillable; type int
                                    • m_nFormCount - nillable; type int
                                    • m_nPswdCount - nillable; type int
                                    • m_sLastDataCollectionDate type string
                                    • m_nPageLinkOffset - nillable; type int
                                    • m_sMaskTan type string
                                    • m_nMaskState - nillable; type int
                                    • m_oPeriod type Period
                                      • m_nPeriodId - nillable; type int
                                      • m_sTitel type string
                                      • m_sStartDate type string
                                      • m_sEndDate type string
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
    38. GetSubunits
      Description:
      Gets all subunits which are stored in the the system database.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSubunitsRequest (soap:header, use = literal, part = Header)Source code
      Output:
      GetSubunitsResponse (soap:body, use = literal)Source code
      UnitList type UnitList
      • Units - optional, unbounded; type Unit
        • m_nId - nillable; type int
        • m_sName type string
        • m_nPublicUnitNumber - nillable; type int
        • m_nImageAccess - nillable; type int
        • m_aUsers type UserList
          • Users - optional, unbounded; type User
            • m_nId - nillable; type int
            • m_nType - nillable; type int
            • m_sLoginName type string
            • m_sExternalId type string
            • m_sTitle type string
            • m_sFirstName type string
            • m_sSurName type string
            • m_sUnitName type string
            • m_sAddress type string
            • m_sEmail type string
            • m_nFbid - nillable; type int
            • m_nAddressId - nillable; type int
            • m_sPassword type string
            • m_sPhoneNumber type string
            • m_aCourses type CourseList
              • Courses - optional, unbounded; type Course
                • m_nCourseId - nillable; type int
                • m_sProgramOfStudy type string
                • m_sCourseTitle type string
                • m_sRoom type string
                • m_nCourseType - nillable; type int
                • m_sPubCourseId type string
                • m_sExternalId type string
                • m_nCountStud - nillable; type int
                • m_aCustomFieldValues type StringList
                  • Strings - optional, unbounded; type string
                • m_nUserId - nillable; type int
                • m_nFbid - nillable; type int
                • m_nPeriodId - nillable; type int
                • m_aoParticipants type PersonList
                  • Persons - optional, unbounded; type Person
                    • m_nId - nillable; type int
                    • m_sTitle type string
                    • m_sFirstname type string
                    • m_sLastname type string
                    • m_sIdentifier type string
                    • m_sEmail type string
                    • m_nGender - nillable; type int
                    • m_sAddress - nillable; type int
                    • m_sCustom1 type string
                    • m_sCustom2 type string
                    • m_sCustom3 type string
                • m_aoSecondaryInstructors type UserList
                  • Users - optional, unbounded; type User
                    • m_nId - nillable; type int
                    • m_nType - nillable; type int
                    • m_sLoginName type string
                    • m_sExternalId type string
                    • m_sTitle type string
                    • m_sFirstName type string
                    • m_sSurName type string
                    • m_sUnitName type string
                    • m_sAddress type string
                    • m_sEmail type string
                    • m_nFbid - nillable; type int
                    • m_nAddressId - nillable; type int
                    • m_sPassword type string
                    • m_sPhoneNumber type string
                    • m_aCourses type CourseList
                      • Courses - optional, unbounded; type Course
                        • m_nCourseId - nillable; type int
                        • m_sProgramOfStudy type string
                        • m_sCourseTitle type string
                        • m_sRoom type string
                        • m_nCourseType - nillable; type int
                        • m_sPubCourseId type string
                        • m_sExternalId type string
                        • m_nCountStud - nillable; type int
                        • m_aCustomFieldValues type StringList
                          • Strings - optional, unbounded; type string
                        • m_nUserId - nillable; type int
                        • m_nFbid - nillable; type int
                        • m_nPeriodId - nillable; type int
                        • m_aoParticipants type PersonList
                          • Persons - optional, unbounded; type Person
                            • m_nId - nillable; type int
                            • m_sTitle type string
                            • m_sFirstname type string
                            • m_sLastname type string
                            • m_sIdentifier type string
                            • m_sEmail type string
                            • m_nGender - nillable; type int
                            • m_sAddress - nillable; type int
                            • m_sCustom1 type string
                            • m_sCustom2 type string
                            • m_sCustom3 type string
                        • m_aoSecondaryInstructors type UserList
                          • Users - optional, unbounded; type User
                            • m_nId - nillable; type int
                            • m_nType - nillable; type int
                            • m_sLoginName type string
                            • m_sExternalId type string
                            • m_sTitle type string
                            • m_sFirstName type string
                            • m_sSurName type string
                            • m_sUnitName type string
                            • m_sAddress type string
                            • m_sEmail type string
                            • m_nFbid - nillable; type int
                            • m_nAddressId - nillable; type int
                            • m_sPassword type string
                            • m_sPhoneNumber type string
                            • m_aCourses type CourseList
                              • Courses - optional, unbounded; type Course
                                • m_nCourseId - nillable; type int
                                • m_sProgramOfStudy type string
                                • m_sCourseTitle type string
                                • m_sRoom type string
                                • m_nCourseType - nillable; type int
                                • m_sPubCourseId type string
                                • m_sExternalId type string
                                • m_nCountStud - nillable; type int
                                • m_aCustomFieldValues type StringList
                                  • Strings - optional, unbounded; type string
                                • m_nUserId - nillable; type int
                                • m_nFbid - nillable; type int
                                • m_nPeriodId - nillable; type int
                                • m_aoParticipants type PersonList
                                  • Persons - optional, unbounded; type Person
                                    • m_nId - nillable; type int
                                    • m_sTitle type string
                                    • m_sFirstname type string
                                    • m_sLastname type string
                                    • m_sIdentifier type string
                                    • m_sEmail type string
                                    • m_nGender - nillable; type int
                                    • m_sAddress - nillable; type int
                                    • m_sCustom1 type string
                                    • m_sCustom2 type string
                                    • m_sCustom3 type string
                                • m_aoSecondaryInstructors type UserList ... is recursive
                                • m_oSurveyHolder type SurveyHolder
                                  • m_aSurveys type SurveyList
                                    • Surveys - optional, unbounded; type Survey
                                      • m_nSurveyId - nillable; type int
                                      • m_nState - nillable; type int
                                      • m_sTitle type string
                                      • m_cType type string
                                      • m_nFrmid - nillable; type int
                                      • m_nStuid - nillable; type int
                                      • m_nVerid - nillable; type int
                                      • m_nOpenState - nillable; type int
                                      • m_nFormCount - nillable; type int
                                      • m_nPswdCount - nillable; type int
                                      • m_sLastDataCollectionDate type string
                                      • m_nPageLinkOffset - nillable; type int
                                      • m_sMaskTan type string
                                      • m_nMaskState - nillable; type int
                                      • m_oPeriod type Period
                                        • m_nPeriodId - nillable; type int
                                        • m_sTitel type string
                                        • m_sStartDate type string
                                        • m_sEndDate type string
                        • m_oSurveyHolder type SurveyHolder
                          • m_aSurveys type SurveyList
                            • Surveys - optional, unbounded; type Survey
                              • m_nSurveyId - nillable; type int
                              • m_nState - nillable; type int
                              • m_sTitle type string
                              • m_cType type string
                              • m_nFrmid - nillable; type int
                              • m_nStuid - nillable; type int
                              • m_nVerid - nillable; type int
                              • m_nOpenState - nillable; type int
                              • m_nFormCount - nillable; type int
                              • m_nPswdCount - nillable; type int
                              • m_sLastDataCollectionDate type string
                              • m_nPageLinkOffset - nillable; type int
                              • m_sMaskTan type string
                              • m_nMaskState - nillable; type int
                              • m_oPeriod type Period
                                • m_nPeriodId - nillable; type int
                                • m_sTitel type string
                                • m_sStartDate type string
                                • m_sEndDate type string
                • m_oSurveyHolder type SurveyHolder
                  • m_aSurveys type SurveyList
                    • Surveys - optional, unbounded; type Survey
                      • m_nSurveyId - nillable; type int
                      • m_nState - nillable; type int
                      • m_sTitle type string
                      • m_cType type string
                      • m_nFrmid - nillable; type int
                      • m_nStuid - nillable; type int
                      • m_nVerid - nillable; type int
                      • m_nOpenState - nillable; type int
                      • m_nFormCount - nillable; type int
                      • m_nPswdCount - nillable; type int
                      • m_sLastDataCollectionDate type string
                      • m_nPageLinkOffset - nillable; type int
                      • m_sMaskTan type string
                      • m_nMaskState - nillable; type int
                      • m_oPeriod type Period
                        • m_nPeriodId - nillable; type int
                        • m_sTitel type string
                        • m_sStartDate type string
                        • m_sEndDate type string
    39. GetSurveyById
      Description:
      Returns the survey referenced by its the system survey ID.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSurveyByIdRequest (soap:header, use = literal, part = Header)Source code
      nSurveyId type int
      Output:
      GetSurveyByIdResponse (soap:body, use = literal)Source code
      Survey type Survey
      • m_nSurveyId - nillable; type int
      • m_nState - nillable; type int
      • m_sTitle type string
      • m_cType type string
      • m_nFrmid - nillable; type int
      • m_nStuid - nillable; type int
      • m_nVerid - nillable; type int
      • m_nOpenState - nillable; type int
      • m_nFormCount - nillable; type int
      • m_nPswdCount - nillable; type int
      • m_sLastDataCollectionDate type string
      • m_nPageLinkOffset - nillable; type int
      • m_sMaskTan type string
      • m_nMaskState - nillable; type int
      • m_oPeriod type Period
        • m_nPeriodId - nillable; type int
        • m_sTitel type string
        • m_sStartDate type string
        • m_sEndDate type string
    40. GetSurveyRawData
      Description:
      Creates an object which includes all sheet results (raw data) of the given survey. The SurveyRawData object also contains the survey object.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSurveyRawDataRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      IncludeOpenEndedQuestions type boolean
      Output:
      GetSurveyRawDataResponse (soap:body, use = literal)Source code
      SurveyRawData type SurveyRawData
      • Survey type Survey
        • m_nSurveyId - nillable; type int
        • m_nState - nillable; type int
        • m_sTitle type string
        • m_cType type string
        • m_nFrmid - nillable; type int
        • m_nStuid - nillable; type int
        • m_nVerid - nillable; type int
        • m_nOpenState - nillable; type int
        • m_nFormCount - nillable; type int
        • m_nPswdCount - nillable; type int
        • m_sLastDataCollectionDate type string
        • m_nPageLinkOffset - nillable; type int
        • m_sMaskTan type string
        • m_nMaskState - nillable; type int
        • m_oPeriod type Period
          • m_nPeriodId - nillable; type int
          • m_sTitel type string
          • m_sStartDate type string
          • m_sEndDate type string
      • SheetResults type ItemAnswerListList
        • ItemAnswerLists - optional, unbounded; type ItemAnswerList
          • ItemAnswers - optional, unbounded; type ItemAnswer
            • ItemId - nillable; type int
            • ItemCode type string
            • ItemValue type string
            • ResultId type string
      • ParticipantList - optional; type ParticipantList
        • SurveyParticipant - optional, unbounded; type SurveyParticipant
          • ResultId type string
          • Person type Person
            • m_nId - nillable; type int
            • m_sTitle type string
            • m_sFirstname type string
            • m_sLastname type string
            • m_sIdentifier type string
            • m_sEmail type string
            • m_nGender - nillable; type int
            • m_sAddress - nillable; type int
            • m_sCustom1 type string
            • m_sCustom2 type string
            • m_sCustom3 type string
    41. GetSurveyRawDataByTime
      Description:
      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 rele-vant surveys will be returned.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSurveyRawDataByTimeRequest (soap:header, use = literal, part = Header)Source code
      StartTime type dateTime
      EndTime type dateTime
      IncludeOpenEndedQuestions type boolean
      Output:
      GetSurveyRawDataByTimeResponse (soap:body, use = literal)Source code
      SurveyRawDataList type SurveyRawDataList
      • SurveyRawDataArray - optional, unbounded; type SurveyRawData
        • Survey type Survey
          • m_nSurveyId - nillable; type int
          • m_nState - nillable; type int
          • m_sTitle type string
          • m_cType type string
          • m_nFrmid - nillable; type int
          • m_nStuid - nillable; type int
          • m_nVerid - nillable; type int
          • m_nOpenState - nillable; type int
          • m_nFormCount - nillable; type int
          • m_nPswdCount - nillable; type int
          • m_sLastDataCollectionDate type string
          • m_nPageLinkOffset - nillable; type int
          • m_sMaskTan type string
          • m_nMaskState - nillable; type int
          • m_oPeriod type Period
            • m_nPeriodId - nillable; type int
            • m_sTitel type string
            • m_sStartDate type string
            • m_sEndDate type string
        • SheetResults type ItemAnswerListList
          • ItemAnswerLists - optional, unbounded; type ItemAnswerList
            • ItemAnswers - optional, unbounded; type ItemAnswer
              • ItemId - nillable; type int
              • ItemCode type string
              • ItemValue type string
              • ResultId type string
        • ParticipantList - optional; type ParticipantList
          • SurveyParticipant - optional, unbounded; type SurveyParticipant
            • ResultId type string
            • Person type Person
              • m_nId - nillable; type int
              • m_sTitle type string
              • m_sFirstname type string
              • m_sLastname type string
              • m_sIdentifier type string
              • m_sEmail type string
              • m_nGender - nillable; type int
              • m_sAddress - nillable; type int
              • m_sCustom1 type string
              • m_sCustom2 type string
              • m_sCustom3 type string
    42. GetSurveyResults
      Description:
      Creates an object which includes all statistical results for all questions and question groups (indicators) of the given survey. The SurveyResultRawData object also con-tains the survey object. Statistical results include: Response count, mean, median, standard deviation, frequency distribution, absten-tion count, normed mean.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSurveyResultsRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      Output:
      GetSurveyResultsResponse (soap:body, use = literal)Source code
      SurveyResult type SurveyResult
      • Survey type Survey
        • m_nSurveyId - nillable; type int
        • m_nState - nillable; type int
        • m_sTitle type string
        • m_cType type string
        • m_nFrmid - nillable; type int
        • m_nStuid - nillable; type int
        • m_nVerid - nillable; type int
        • m_nOpenState - nillable; type int
        • m_nFormCount - nillable; type int
        • m_nPswdCount - nillable; type int
        • m_sLastDataCollectionDate type string
        • m_nPageLinkOffset - nillable; type int
        • m_sMaskTan type string
        • m_nMaskState - nillable; type int
        • m_oPeriod type Period
          • m_nPeriodId - nillable; type int
          • m_sTitel type string
          • m_sStartDate type string
          • m_sEndDate type string
      • ItemResults type ItemResultList
        • ItemResults - optional, unbounded; type ItemResult
          • ItemId - nillable; type int
          • ItemCode type string
          • ResponseCount - nillable; type int
          • AbstentionCount - nillable; type int
          • FrequencyDistribution type FrequencyList
            • Frequencies - optional, unbounded; type float
          • Mean type float
          • StdDev type float
          • Median type float
          • Norm type float
      • ItemGroupResults type ItemGroupResultList
        • ItemGroupResults - optional, unbounded; type ItemGroupResult
          • ItemGroupId - nillable; type int
          • Mean type float
          • StdDev type float
          • Norm type float
    43. GetSurveyTypes
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSurveyTypesRequest (soap:header, use = literal, part = Header)Source code
      Output:
      GetSurveyTypesResponse (soap:body, use = literal)Source code
      SurveyTypeList type SurveyTypeList
      • SurveyTypes - optional, unbounded; type SurveyType
        • m_chSurveyType type string
        • m_sDescription type string
    44. GetSurveysByCourse
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetSurveysByCourseRequest (soap:header, use = literal, part = Header)Source code
      nCourseId type int
      nFormId type int
      nPeriodId type int
      Output:
      GetSurveysByCourseResponse (soap:body, use = literal)Source code
      SurveyList type SurveyList
      • Surveys - optional, unbounded; type Survey
        • m_nSurveyId - nillable; type int
        • m_nState - nillable; type int
        • m_sTitle type string
        • m_cType type string
        • m_nFrmid - nillable; type int
        • m_nStuid - nillable; type int
        • m_nVerid - nillable; type int
        • m_nOpenState - nillable; type int
        • m_nFormCount - nillable; type int
        • m_nPswdCount - nillable; type int
        • m_sLastDataCollectionDate type string
        • m_nPageLinkOffset - nillable; type int
        • m_sMaskTan type string
        • m_nMaskState - nillable; type int
        • m_oPeriod type Period
          • m_nPeriodId - nillable; type int
          • m_sTitel type string
          • m_sStartDate type string
          • m_sEndDate type string
    45. GetUser
      Description:
      Returns the the system user, referenced by his internal the system 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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetUserRequest (soap:header, use = literal, part = Header)Source code
      UserId type string
      IdType type UserIdType - type string with restriction - enum { 'INTERNAL', 'LOGIN', 'EXTERNAL' }
      IncludeCourses type boolean
      IncludeSurveys type boolean
      IncludeParticipants type boolean
      IncludeSecondaryCourses type boolean
      Output:
      GetUserResponse (soap:body, use = literal)Source code
      User type User
      • m_nId - nillable; type int
      • m_nType - nillable; type int
      • m_sLoginName type string
      • m_sExternalId type string
      • m_sTitle type string
      • m_sFirstName type string
      • m_sSurName type string
      • m_sUnitName type string
      • m_sAddress type string
      • m_sEmail type string
      • m_nFbid - nillable; type int
      • m_nAddressId - nillable; type int
      • m_sPassword type string
      • m_sPhoneNumber type string
      • m_aCourses type CourseList
        • Courses - optional, unbounded; type Course
          • m_nCourseId - nillable; type int
          • m_sProgramOfStudy type string
          • m_sCourseTitle type string
          • m_sRoom type string
          • m_nCourseType - nillable; type int
          • m_sPubCourseId type string
          • m_sExternalId type string
          • m_nCountStud - nillable; type int
          • m_aCustomFieldValues type StringList
            • Strings - optional, unbounded; type string
          • m_nUserId - nillable; type int
          • m_nFbid - nillable; type int
          • m_nPeriodId - nillable; type int
          • m_aoParticipants type PersonList
            • Persons - optional, unbounded; type Person
              • m_nId - nillable; type int
              • m_sTitle type string
              • m_sFirstname type string
              • m_sLastname type string
              • m_sIdentifier type string
              • m_sEmail type string
              • m_nGender - nillable; type int
              • m_sAddress - nillable; type int
              • m_sCustom1 type string
              • m_sCustom2 type string
              • m_sCustom3 type string
          • m_aoSecondaryInstructors type UserList
            • Users - optional, unbounded; type User
              • m_nId - nillable; type int
              • m_nType - nillable; type int
              • m_sLoginName type string
              • m_sExternalId type string
              • m_sTitle type string
              • m_sFirstName type string
              • m_sSurName type string
              • m_sUnitName type string
              • m_sAddress type string
              • m_sEmail type string
              • m_nFbid - nillable; type int
              • m_nAddressId - nillable; type int
              • m_sPassword type string
              • m_sPhoneNumber type string
              • m_aCourses type CourseList
                • Courses - optional, unbounded; type Course
                  • m_nCourseId - nillable; type int
                  • m_sProgramOfStudy type string
                  • m_sCourseTitle type string
                  • m_sRoom type string
                  • m_nCourseType - nillable; type int
                  • m_sPubCourseId type string
                  • m_sExternalId type string
                  • m_nCountStud - nillable; type int
                  • m_aCustomFieldValues type StringList
                    • Strings - optional, unbounded; type string
                  • m_nUserId - nillable; type int
                  • m_nFbid - nillable; type int
                  • m_nPeriodId - nillable; type int
                  • m_aoParticipants type PersonList
                    • Persons - optional, unbounded; type Person
                      • m_nId - nillable; type int
                      • m_sTitle type string
                      • m_sFirstname type string
                      • m_sLastname type string
                      • m_sIdentifier type string
                      • m_sEmail type string
                      • m_nGender - nillable; type int
                      • m_sAddress - nillable; type int
                      • m_sCustom1 type string
                      • m_sCustom2 type string
                      • m_sCustom3 type string
                  • m_aoSecondaryInstructors type UserList
                    • Users - optional, unbounded; type User
                      • m_nId - nillable; type int
                      • m_nType - nillable; type int
                      • m_sLoginName type string
                      • m_sExternalId type string
                      • m_sTitle type string
                      • m_sFirstName type string
                      • m_sSurName type string
                      • m_sUnitName type string
                      • m_sAddress type string
                      • m_sEmail type string
                      • m_nFbid - nillable; type int
                      • m_nAddressId - nillable; type int
                      • m_sPassword type string
                      • m_sPhoneNumber type string
                      • m_aCourses type CourseList
                        • Courses - optional, unbounded; type Course
                          • m_nCourseId - nillable; type int
                          • m_sProgramOfStudy type string
                          • m_sCourseTitle type string
                          • m_sRoom type string
                          • m_nCourseType - nillable; type int
                          • m_sPubCourseId type string
                          • m_sExternalId type string
                          • m_nCountStud - nillable; type int
                          • m_aCustomFieldValues type StringList
                            • Strings - optional, unbounded; type string
                          • m_nUserId - nillable; type int
                          • m_nFbid - nillable; type int
                          • m_nPeriodId - nillable; type int
                          • m_aoParticipants type PersonList
                            • Persons - optional, unbounded; type Person
                              • m_nId - nillable; type int
                              • m_sTitle type string
                              • m_sFirstname type string
                              • m_sLastname type string
                              • m_sIdentifier type string
                              • m_sEmail type string
                              • m_nGender - nillable; type int
                              • m_sAddress - nillable; type int
                              • m_sCustom1 type string
                              • m_sCustom2 type string
                              • m_sCustom3 type string
                          • m_aoSecondaryInstructors type UserList
                            • Users - optional, unbounded; type User ... is recursive
                          • m_oSurveyHolder type SurveyHolder
                            • m_aSurveys type SurveyList
                              • Surveys - optional, unbounded; type Survey
                                • m_nSurveyId - nillable; type int
                                • m_nState - nillable; type int
                                • m_sTitle type string
                                • m_cType type string
                                • m_nFrmid - nillable; type int
                                • m_nStuid - nillable; type int
                                • m_nVerid - nillable; type int
                                • m_nOpenState - nillable; type int
                                • m_nFormCount - nillable; type int
                                • m_nPswdCount - nillable; type int
                                • m_sLastDataCollectionDate type string
                                • m_nPageLinkOffset - nillable; type int
                                • m_sMaskTan type string
                                • m_nMaskState - nillable; type int
                                • m_oPeriod type Period
                                  • m_nPeriodId - nillable; type int
                                  • m_sTitel type string
                                  • m_sStartDate type string
                                  • m_sEndDate type string
                  • m_oSurveyHolder type SurveyHolder
                    • m_aSurveys type SurveyList
                      • Surveys - optional, unbounded; type Survey
                        • m_nSurveyId - nillable; type int
                        • m_nState - nillable; type int
                        • m_sTitle type string
                        • m_cType type string
                        • m_nFrmid - nillable; type int
                        • m_nStuid - nillable; type int
                        • m_nVerid - nillable; type int
                        • m_nOpenState - nillable; type int
                        • m_nFormCount - nillable; type int
                        • m_nPswdCount - nillable; type int
                        • m_sLastDataCollectionDate type string
                        • m_nPageLinkOffset - nillable; type int
                        • m_sMaskTan type string
                        • m_nMaskState - nillable; type int
                        • m_oPeriod type Period
                          • m_nPeriodId - nillable; type int
                          • m_sTitel type string
                          • m_sStartDate type string
                          • m_sEndDate type string
          • m_oSurveyHolder type SurveyHolder
            • m_aSurveys type SurveyList
              • Surveys - optional, unbounded; type Survey
                • m_nSurveyId - nillable; type int
                • m_nState - nillable; type int
                • m_sTitle type string
                • m_cType type string
                • m_nFrmid - nillable; type int
                • m_nStuid - nillable; type int
                • m_nVerid - nillable; type int
                • m_nOpenState - nillable; type int
                • m_nFormCount - nillable; type int
                • m_nPswdCount - nillable; type int
                • m_sLastDataCollectionDate type string
                • m_nPageLinkOffset - nillable; type int
                • m_sMaskTan type string
                • m_nMaskState - nillable; type int
                • m_oPeriod type Period
                  • m_nPeriodId - nillable; type int
                  • m_sTitel type string
                  • m_sStartDate type string
                  • m_sEndDate type string
    46. GetUserVolumeLicenses
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetUserVolumeLicensesRequest (soap:header, use = literal, part = Header)Source code
      UserId type int
      Output:
      GetUserVolumeLicensesResponse (soap:body, use = literal)Source code
      Licenses type VolumeLicenseList
      • VolumeLicenses - optional, unbounded; type VolumeLicense
        • LicenseId type int
        • LicenseVolume type int
        • LicenseCycles type int
        • LicenseStartDate type string
        • LicenseEndDate type string
        • LicenseActivityStatus type boolean
        • UsedLicenseCycles type int
        • UsedLicenseVolume type float
        • LicenseKey type string
    47. GetUsersBySubunit
      Description:
      Returns all users of the subunit of the type instructor.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetUsersBySubunitRequest (soap:header, use = literal, part = Header)Source code
      nSubunitId type int
      Output:
      GetUsersBySubunitResponse (soap:body, use = literal)Source code
      UserList type UserList
      • Users - optional, unbounded; type User
        • m_nId - nillable; type int
        • m_nType - nillable; type int
        • m_sLoginName type string
        • m_sExternalId type string
        • m_sTitle type string
        • m_sFirstName type string
        • m_sSurName type string
        • m_sUnitName type string
        • m_sAddress type string
        • m_sEmail type string
        • m_nFbid - nillable; type int
        • m_nAddressId - nillable; type int
        • m_sPassword type string
        • m_sPhoneNumber type string
        • m_aCourses type CourseList
          • Courses - optional, unbounded; type Course
            • m_nCourseId - nillable; type int
            • m_sProgramOfStudy type string
            • m_sCourseTitle type string
            • m_sRoom type string
            • m_nCourseType - nillable; type int
            • m_sPubCourseId type string
            • m_sExternalId type string
            • m_nCountStud - nillable; type int
            • m_aCustomFieldValues type StringList
              • Strings - optional, unbounded; type string
            • m_nUserId - nillable; type int
            • m_nFbid - nillable; type int
            • m_nPeriodId - nillable; type int
            • m_aoParticipants type PersonList
              • Persons - optional, unbounded; type Person
                • m_nId - nillable; type int
                • m_sTitle type string
                • m_sFirstname type string
                • m_sLastname type string
                • m_sIdentifier type string
                • m_sEmail type string
                • m_nGender - nillable; type int
                • m_sAddress - nillable; type int
                • m_sCustom1 type string
                • m_sCustom2 type string
                • m_sCustom3 type string
            • m_aoSecondaryInstructors type UserList
              • Users - optional, unbounded; type User
                • m_nId - nillable; type int
                • m_nType - nillable; type int
                • m_sLoginName type string
                • m_sExternalId type string
                • m_sTitle type string
                • m_sFirstName type string
                • m_sSurName type string
                • m_sUnitName type string
                • m_sAddress type string
                • m_sEmail type string
                • m_nFbid - nillable; type int
                • m_nAddressId - nillable; type int
                • m_sPassword type string
                • m_sPhoneNumber type string
                • m_aCourses type CourseList
                  • Courses - optional, unbounded; type Course
                    • m_nCourseId - nillable; type int
                    • m_sProgramOfStudy type string
                    • m_sCourseTitle type string
                    • m_sRoom type string
                    • m_nCourseType - nillable; type int
                    • m_sPubCourseId type string
                    • m_sExternalId type string
                    • m_nCountStud - nillable; type int
                    • m_aCustomFieldValues type StringList
                      • Strings - optional, unbounded; type string
                    • m_nUserId - nillable; type int
                    • m_nFbid - nillable; type int
                    • m_nPeriodId - nillable; type int
                    • m_aoParticipants type PersonList
                      • Persons - optional, unbounded; type Person
                        • m_nId - nillable; type int
                        • m_sTitle type string
                        • m_sFirstname type string
                        • m_sLastname type string
                        • m_sIdentifier type string
                        • m_sEmail type string
                        • m_nGender - nillable; type int
                        • m_sAddress - nillable; type int
                        • m_sCustom1 type string
                        • m_sCustom2 type string
                        • m_sCustom3 type string
                    • m_aoSecondaryInstructors type UserList
                      • Users - optional, unbounded; type User
                        • m_nId - nillable; type int
                        • m_nType - nillable; type int
                        • m_sLoginName type string
                        • m_sExternalId type string
                        • m_sTitle type string
                        • m_sFirstName type string
                        • m_sSurName type string
                        • m_sUnitName type string
                        • m_sAddress type string
                        • m_sEmail type string
                        • m_nFbid - nillable; type int
                        • m_nAddressId - nillable; type int
                        • m_sPassword type string
                        • m_sPhoneNumber type string
                        • m_aCourses type CourseList
                          • Courses - optional, unbounded; type Course
                            • m_nCourseId - nillable; type int
                            • m_sProgramOfStudy type string
                            • m_sCourseTitle type string
                            • m_sRoom type string
                            • m_nCourseType - nillable; type int
                            • m_sPubCourseId type string
                            • m_sExternalId type string
                            • m_nCountStud - nillable; type int
                            • m_aCustomFieldValues type StringList
                              • Strings - optional, unbounded; type string
                            • m_nUserId - nillable; type int
                            • m_nFbid - nillable; type int
                            • m_nPeriodId - nillable; type int
                            • m_aoParticipants type PersonList
                              • Persons - optional, unbounded; type Person
                                • m_nId - nillable; type int
                                • m_sTitle type string
                                • m_sFirstname type string
                                • m_sLastname type string
                                • m_sIdentifier type string
                                • m_sEmail type string
                                • m_nGender - nillable; type int
                                • m_sAddress - nillable; type int
                                • m_sCustom1 type string
                                • m_sCustom2 type string
                                • m_sCustom3 type string
                            • m_aoSecondaryInstructors type UserList ... is recursive
                            • m_oSurveyHolder type SurveyHolder
                              • m_aSurveys type SurveyList
                                • Surveys - optional, unbounded; type Survey
                                  • m_nSurveyId - nillable; type int
                                  • m_nState - nillable; type int
                                  • m_sTitle type string
                                  • m_cType type string
                                  • m_nFrmid - nillable; type int
                                  • m_nStuid - nillable; type int
                                  • m_nVerid - nillable; type int
                                  • m_nOpenState - nillable; type int
                                  • m_nFormCount - nillable; type int
                                  • m_nPswdCount - nillable; type int
                                  • m_sLastDataCollectionDate type string
                                  • m_nPageLinkOffset - nillable; type int
                                  • m_sMaskTan type string
                                  • m_nMaskState - nillable; type int
                                  • m_oPeriod type Period
                                    • m_nPeriodId - nillable; type int
                                    • m_sTitel type string
                                    • m_sStartDate type string
                                    • m_sEndDate type string
                    • m_oSurveyHolder type SurveyHolder
                      • m_aSurveys type SurveyList
                        • Surveys - optional, unbounded; type Survey
                          • m_nSurveyId - nillable; type int
                          • m_nState - nillable; type int
                          • m_sTitle type string
                          • m_cType type string
                          • m_nFrmid - nillable; type int
                          • m_nStuid - nillable; type int
                          • m_nVerid - nillable; type int
                          • m_nOpenState - nillable; type int
                          • m_nFormCount - nillable; type int
                          • m_nPswdCount - nillable; type int
                          • m_sLastDataCollectionDate type string
                          • m_nPageLinkOffset - nillable; type int
                          • m_sMaskTan type string
                          • m_nMaskState - nillable; type int
                          • m_oPeriod type Period
                            • m_nPeriodId - nillable; type int
                            • m_sTitel type string
                            • m_sStartDate type string
                            • m_sEndDate type string
            • m_oSurveyHolder type SurveyHolder
              • m_aSurveys type SurveyList
                • Surveys - optional, unbounded; type Survey
                  • m_nSurveyId - nillable; type int
                  • m_nState - nillable; type int
                  • m_sTitle type string
                  • m_cType type string
                  • m_nFrmid - nillable; type int
                  • m_nStuid - nillable; type int
                  • m_nVerid - nillable; type int
                  • m_nOpenState - nillable; type int
                  • m_nFormCount - nillable; type int
                  • m_nPswdCount - nillable; type int
                  • m_sLastDataCollectionDate type string
                  • m_nPageLinkOffset - nillable; type int
                  • m_sMaskTan type string
                  • m_nMaskState - nillable; type int
                  • m_oPeriod type Period
                    • m_nPeriodId - nillable; type int
                    • m_sTitel type string
                    • m_sStartDate type string
                    • m_sEndDate type string
    48. GetVFD
      Description:
      The function exports a form into an .vfd (=VFD/VividForms form definition file )-file and returns a link to it.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      GetVFDRequest (soap:header, use = literal, part = Header)Source code
      FormId type int
      IncludeSecondaryData type boolean
      Output:
      GetVFDResponse (soap:body, use = literal)Source code
      HyperLink type string
    49. InsertCentralSurvey
      Description:
      Creates a new survey for central evaluation based on internal IDs.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertCentralSurveyRequest (soap:header, use = literal, part = Header)Source code
      nUserId type int
      nCourseId type int
      nFormId type int
      nPeriodId type int
      sSurveyType type string
      sNotice type string
      Output:
      InsertCentralSurveyResponse (soap:body, use = literal)Source code
      return type Survey
      • m_nSurveyId - nillable; type int
      • m_nState - nillable; type int
      • m_sTitle type string
      • m_cType type string
      • m_nFrmid - nillable; type int
      • m_nStuid - nillable; type int
      • m_nVerid - nillable; type int
      • m_nOpenState - nillable; type int
      • m_nFormCount - nillable; type int
      • m_nPswdCount - nillable; type int
      • m_sLastDataCollectionDate type string
      • m_nPageLinkOffset - nillable; type int
      • m_sMaskTan type string
      • m_nMaskState - nillable; type int
      • m_oPeriod type Period
        • m_nPeriodId - nillable; type int
        • m_sTitel type string
        • m_sStartDate type string
        • m_sEndDate type string
    50. InsertCloseTask
      Description:
      Store the changes made to the CloseTask in the database.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertCloseTaskRequest (soap:header, use = literal, part = Header)Source code
      CloseTask type CloseTask
      • SurveyID type string
      • StartTime - nillable; type dateTime
      • TaskID - optional; type string
      • Status - optional; type string
      • SendReport - optional; type boolean
      Output:
      InsertCloseTaskResponse (soap:body, use = literal)Source code
      TaskId type int
    51. InsertCourse
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertCourseRequest (soap:header, use = literal, part = Header)Source code
      oCourse type Course
      • m_nCourseId - nillable; type int
      • m_sProgramOfStudy type string
      • m_sCourseTitle type string
      • m_sRoom type string
      • m_nCourseType - nillable; type int
      • m_sPubCourseId type string
      • m_sExternalId type string
      • m_nCountStud - nillable; type int
      • m_aCustomFieldValues type StringList
        • Strings - optional, unbounded; type string
      • m_nUserId - nillable; type int
      • m_nFbid - nillable; type int
      • m_nPeriodId - nillable; type int
      • m_aoParticipants type PersonList
        • Persons - optional, unbounded; type Person
          • m_nId - nillable; type int
          • m_sTitle type string
          • m_sFirstname type string
          • m_sLastname type string
          • m_sIdentifier type string
          • m_sEmail type string
          • m_nGender - nillable; type int
          • m_sAddress - nillable; type int
          • m_sCustom1 type string
          • m_sCustom2 type string
          • m_sCustom3 type string
      • m_aoSecondaryInstructors type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course ... is recursive
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
      • m_oSurveyHolder type SurveyHolder
        • m_aSurveys type SurveyList
          • Surveys - optional, unbounded; type Survey
            • m_nSurveyId - nillable; type int
            • m_nState - nillable; type int
            • m_sTitle type string
            • m_cType type string
            • m_nFrmid - nillable; type int
            • m_nStuid - nillable; type int
            • m_nVerid - nillable; type int
            • m_nOpenState - nillable; type int
            • m_nFormCount - nillable; type int
            • m_nPswdCount - nillable; type int
            • m_sLastDataCollectionDate type string
            • m_nPageLinkOffset - nillable; type int
            • m_sMaskTan type string
            • m_nMaskState - nillable; type int
            • m_oPeriod type Period
              • m_nPeriodId - nillable; type int
              • m_sTitel type string
              • m_sStartDate type string
              • m_sEndDate type string
      Output:
      InsertCourseResponse (soap:body, use = literal)Source code
      Course type Course
      • m_nCourseId - nillable; type int
      • m_sProgramOfStudy type string
      • m_sCourseTitle type string
      • m_sRoom type string
      • m_nCourseType - nillable; type int
      • m_sPubCourseId type string
      • m_sExternalId type string
      • m_nCountStud - nillable; type int
      • m_aCustomFieldValues type StringList
        • Strings - optional, unbounded; type string
      • m_nUserId - nillable; type int
      • m_nFbid - nillable; type int
      • m_nPeriodId - nillable; type int
      • m_aoParticipants type PersonList
        • Persons - optional, unbounded; type Person
          • m_nId - nillable; type int
          • m_sTitle type string
          • m_sFirstname type string
          • m_sLastname type string
          • m_sIdentifier type string
          • m_sEmail type string
          • m_nGender - nillable; type int
          • m_sAddress - nillable; type int
          • m_sCustom1 type string
          • m_sCustom2 type string
          • m_sCustom3 type string
      • m_aoSecondaryInstructors type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course ... is recursive
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
      • m_oSurveyHolder type SurveyHolder
        • m_aSurveys type SurveyList
          • Surveys - optional, unbounded; type Survey
            • m_nSurveyId - nillable; type int
            • m_nState - nillable; type int
            • m_sTitle type string
            • m_cType type string
            • m_nFrmid - nillable; type int
            • m_nStuid - nillable; type int
            • m_nVerid - nillable; type int
            • m_nOpenState - nillable; type int
            • m_nFormCount - nillable; type int
            • m_nPswdCount - nillable; type int
            • m_sLastDataCollectionDate type string
            • m_nPageLinkOffset - nillable; type int
            • m_sMaskTan type string
            • m_nMaskState - nillable; type int
            • m_oPeriod type Period
              • m_nPeriodId - nillable; type int
              • m_sTitel type string
              • m_sStartDate type string
              • m_sEndDate type string
    52. InsertForm
      Description:
      This method inserts a complete form/questionnaire into the database. The object re-turned contains the given internal database keys. The owner of the form will always be the main administrator. Notes: • An update of existing forms is not possible. • Deleting forms via SOAP is not possible. • The form elements “Picture” and “Double scale question” are not yet support-ed by this transaction.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertFormRequest (soap:header, use = literal, part = Header)Source code
      VFForm type VFForm
      • FormId - nillable; type int
      • FormName type string
      • FormTitle type string
      • OwnerId - nillable; type int
      • PaperFormat type string
      • ShowNumeration type boolean
      • AnswerBoxSize - nillable; type int
      • MaxPages - nillable; type int
      • MaxQuestions - nillable; type int
      • FontFamily type string
      • FontSize - nillable; type int
      • RowHeight - nillable; type int
      • CreateDate type string
      • IsActivated type boolean
      • ResultAccess type boolean
      • HeadLineUpperLeft type string
      • HeadLineLowerLeft type string
      • HeadLineUpperRight type string
      • HeadLineLowerRight type string
      • HeadLineMark type string
      • HeadLineCorrection type string
      • ItemGroupList type ItemGroupList
        • ItemGroups - optional, unbounded; type ItemGroup
          • ItemGroupId - nillable; type int
          • Position - nillable; type int
          • Title type string
          • Description type string
          • IndicatorDimension - nillable; type int
          • IsText type boolean
          • FontSize - nillable; type int
          • ItemList type ItemList
            • Items - optional, unbounded; type Item
              • ItemId - nillable; type int
              • Position - nillable; type int
              • Title type string
              • ItemCode type string
              • AnswerCount - nillable; type int
              • Type type QuestionTypes - type int with restriction - enum { '0', '2', '4', '6', '8', '10', '14', '1001', '1002', '1003', '1004', '1005', '1006' }
              • Options type StringList
                • Strings - optional, unbounded; type string
              • GraphType type string
              • Abstention type string
              • Orientation type string
              • RowCount - nillable; type int
              • IsMirrored type boolean
              • UseIcr type string
              • ShowDropdown type boolean
              • MaximalAnswers - nillable; type int
              • Alignment type Alignment - type string with restriction - enum { 'right', 'left', 'center', 'justify', '' }
              • Degree - nillable; type int
      • HeaderLineCount - nillable; type int
      • AdditionalHeaderLineList type AdditionalHeaderLineList
        • AdditionalHeaderLines - optional; type AdditionalHeaderLine
          • LeftFieldContent - nillable; type string
          • RightFieldContent - nillable; type string
      Output:
      InsertFormResponse (soap:body, use = literal)Source code
      VFForm type VFForm
      • FormId - nillable; type int
      • FormName type string
      • FormTitle type string
      • OwnerId - nillable; type int
      • PaperFormat type string
      • ShowNumeration type boolean
      • AnswerBoxSize - nillable; type int
      • MaxPages - nillable; type int
      • MaxQuestions - nillable; type int
      • FontFamily type string
      • FontSize - nillable; type int
      • RowHeight - nillable; type int
      • CreateDate type string
      • IsActivated type boolean
      • ResultAccess type boolean
      • HeadLineUpperLeft type string
      • HeadLineLowerLeft type string
      • HeadLineUpperRight type string
      • HeadLineLowerRight type string
      • HeadLineMark type string
      • HeadLineCorrection type string
      • ItemGroupList type ItemGroupList
        • ItemGroups - optional, unbounded; type ItemGroup
          • ItemGroupId - nillable; type int
          • Position - nillable; type int
          • Title type string
          • Description type string
          • IndicatorDimension - nillable; type int
          • IsText type boolean
          • FontSize - nillable; type int
          • ItemList type ItemList
            • Items - optional, unbounded; type Item
              • ItemId - nillable; type int
              • Position - nillable; type int
              • Title type string
              • ItemCode type string
              • AnswerCount - nillable; type int
              • Type type QuestionTypes - type int with restriction - enum { '0', '2', '4', '6', '8', '10', '14', '1001', '1002', '1003', '1004', '1005', '1006' }
              • Options type StringList
                • Strings - optional, unbounded; type string
              • GraphType type string
              • Abstention type string
              • Orientation type string
              • RowCount - nillable; type int
              • IsMirrored type boolean
              • UseIcr type string
              • ShowDropdown type boolean
              • MaximalAnswers - nillable; type int
              • Alignment type Alignment - type string with restriction - enum { 'right', 'left', 'center', 'justify', '' }
              • Degree - nillable; type int
      • HeaderLineCount - nillable; type int
      • AdditionalHeaderLineList type AdditionalHeaderLineList
        • AdditionalHeaderLines - optional; type AdditionalHeaderLine
          • LeftFieldContent - nillable; type string
          • RightFieldContent - nillable; type string
    53. InsertInvitationTask
      Description:
      Add an InvitationTask in the database.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertInvitationTaskRequest (soap:header, use = literal, part = Header)Source code
      InvitationTask type InvitationTask
      • SurveyID type string
      • StartTime - nillable; type dateTime
      • TaskID - optional; type string
      • Status - optional; type string
      • SenderName - optional; type string
      • SenderEmail - optional; type string
      • EmailText - optional; type string
      • EmailSubject - optional; type string
      Output:
      InsertInvitationTaskResponse (soap:body, use = literal)Source code
      TaskId type int
    54. InsertParticipants
      Description:
      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”.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertParticipantsRequest (soap:header, use = literal, part = Header)Source code
      PersonList type PersonList
      • Persons - optional, unbounded; type Person
        • m_nId - nillable; type int
        • m_sTitle type string
        • m_sFirstname type string
        • m_sLastname type string
        • m_sIdentifier type string
        • m_sEmail type string
        • m_nGender - nillable; type int
        • m_sAddress - nillable; type int
        • m_sCustom1 type string
        • m_sCustom2 type string
        • m_sCustom3 type string
      CourseId type string
      IdType type CourseIdType - type string with restriction - enum { 'INTERNAL', 'PUBLIC', 'EXTERNAL' }
      DeleteExisting type boolean
      Output:
      InsertParticipantsResponse (soap:body, use = literal)Source code
      Success type boolean
    55. InsertRemindTask
      Description:
      Store the changes made to the RemindTask in the database.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertRemindTaskRequest (soap:header, use = literal, part = Header)Source code
      RemindTask type RemindTask
      • SurveyID type string
      • StartTime - nillable; type dateTime
      • TaskID - optional; type string
      • Status - optional; type string
      • SenderName - optional; type string
      • SenderEmail - optional; type string
      • EmailText - optional; type string
      • EmailSubject - optional; type string
      • RepeatAfterDays - optional, nillable; type int
      Output:
      InsertRemindTaskResponse (soap:body, use = literal)Source code
      TaskId type int
    56. InsertResponseRateTask
      Description:
      Insertes a scheduled task of type "OnlineSurveyEmailsResponseRate".
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertResponseRateTaskRequest (soap:header, use = literal, part = Header)Source code
      ResponseRateTask type ResponseRateTask
      • SurveyID type string
      • StartTime - nillable; type dateTime
      • TaskID - optional; type string
      • Status - optional; type string
      • ResponseRateValue - optional, nillable; type int
      • CalcMethod - optional, nillable; type int
      • MailToInstructor - optional; type boolean
      • MailToDean - optional; type boolean
      Output:
      InsertResponseRateTaskResponse (soap:body, use = literal)Source code
      TaskId type int
    57. InsertSubunit
      Description:
      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 “UploadSessions” for mass import of course and instructor data.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertSubunitRequest (soap:header, use = literal, part = Header)Source code
      Unit type Unit
      • m_nId - nillable; type int
      • m_sName type string
      • m_nPublicUnitNumber - nillable; type int
      • m_nImageAccess - nillable; type int
      • m_aUsers type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course
                              • m_nCourseId - nillable; type int
                              • m_sProgramOfStudy type string
                              • m_sCourseTitle type string
                              • m_sRoom type string
                              • m_nCourseType - nillable; type int
                              • m_sPubCourseId type string
                              • m_sExternalId type string
                              • m_nCountStud - nillable; type int
                              • m_aCustomFieldValues type StringList
                                • Strings - optional, unbounded; type string
                              • m_nUserId - nillable; type int
                              • m_nFbid - nillable; type int
                              • m_nPeriodId - nillable; type int
                              • m_aoParticipants type PersonList
                                • Persons - optional, unbounded; type Person
                                  • m_nId - nillable; type int
                                  • m_sTitle type string
                                  • m_sFirstname type string
                                  • m_sLastname type string
                                  • m_sIdentifier type string
                                  • m_sEmail type string
                                  • m_nGender - nillable; type int
                                  • m_sAddress - nillable; type int
                                  • m_sCustom1 type string
                                  • m_sCustom2 type string
                                  • m_sCustom3 type string
                              • m_aoSecondaryInstructors type UserList ... is recursive
                              • m_oSurveyHolder type SurveyHolder
                                • m_aSurveys type SurveyList
                                  • Surveys - optional, unbounded; type Survey
                                    • m_nSurveyId - nillable; type int
                                    • m_nState - nillable; type int
                                    • m_sTitle type string
                                    • m_cType type string
                                    • m_nFrmid - nillable; type int
                                    • m_nStuid - nillable; type int
                                    • m_nVerid - nillable; type int
                                    • m_nOpenState - nillable; type int
                                    • m_nFormCount - nillable; type int
                                    • m_nPswdCount - nillable; type int
                                    • m_sLastDataCollectionDate type string
                                    • m_nPageLinkOffset - nillable; type int
                                    • m_sMaskTan type string
                                    • m_nMaskState - nillable; type int
                                    • m_oPeriod type Period
                                      • m_nPeriodId - nillable; type int
                                      • m_sTitel type string
                                      • m_sStartDate type string
                                      • m_sEndDate type string
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
      Output:
      InsertSubunitResponse (soap:body, use = literal)Source code
      Unit type Unit
      • m_nId - nillable; type int
      • m_sName type string
      • m_nPublicUnitNumber - nillable; type int
      • m_nImageAccess - nillable; type int
      • m_aUsers type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course
                              • m_nCourseId - nillable; type int
                              • m_sProgramOfStudy type string
                              • m_sCourseTitle type string
                              • m_sRoom type string
                              • m_nCourseType - nillable; type int
                              • m_sPubCourseId type string
                              • m_sExternalId type string
                              • m_nCountStud - nillable; type int
                              • m_aCustomFieldValues type StringList
                                • Strings - optional, unbounded; type string
                              • m_nUserId - nillable; type int
                              • m_nFbid - nillable; type int
                              • m_nPeriodId - nillable; type int
                              • m_aoParticipants type PersonList
                                • Persons - optional, unbounded; type Person
                                  • m_nId - nillable; type int
                                  • m_sTitle type string
                                  • m_sFirstname type string
                                  • m_sLastname type string
                                  • m_sIdentifier type string
                                  • m_sEmail type string
                                  • m_nGender - nillable; type int
                                  • m_sAddress - nillable; type int
                                  • m_sCustom1 type string
                                  • m_sCustom2 type string
                                  • m_sCustom3 type string
                              • m_aoSecondaryInstructors type UserList ... is recursive
                              • m_oSurveyHolder type SurveyHolder
                                • m_aSurveys type SurveyList
                                  • Surveys - optional, unbounded; type Survey
                                    • m_nSurveyId - nillable; type int
                                    • m_nState - nillable; type int
                                    • m_sTitle type string
                                    • m_cType type string
                                    • m_nFrmid - nillable; type int
                                    • m_nStuid - nillable; type int
                                    • m_nVerid - nillable; type int
                                    • m_nOpenState - nillable; type int
                                    • m_nFormCount - nillable; type int
                                    • m_nPswdCount - nillable; type int
                                    • m_sLastDataCollectionDate type string
                                    • m_nPageLinkOffset - nillable; type int
                                    • m_sMaskTan type string
                                    • m_nMaskState - nillable; type int
                                    • m_oPeriod type Period
                                      • m_nPeriodId - nillable; type int
                                      • m_sTitel type string
                                      • m_sStartDate type string
                                      • m_sEndDate type string
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
    58. InsertSurveyNotice
      Description:
      Inserts a notice to a survey using – in the name of the given user. The user can be referenced by internal (PK), external (FK) or Login (User name).
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertSurveyNoticeRequest (soap:header, use = literal, part = Header)Source code
      SurveyId type int
      Notice type string
      UserId type string
      IdType type UserIdType - type string with restriction - enum { 'INTERNAL', 'LOGIN', 'EXTERNAL' }
      Output:
      InsertSurveyNoticeResponse (soap:body, use = literal)Source code
      Success type boolean
    59. InsertUser
      Description:
      Inserts the user shown into the database. Please note: Child objects like courses will not be inserted by this method. Please use the method “UploadSessions” in order to mass import/update course and in-structor data.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      InsertUserRequest (soap:header, use = literal, part = Header)Source code
      User type User
      • m_nId - nillable; type int
      • m_nType - nillable; type int
      • m_sLoginName type string
      • m_sExternalId type string
      • m_sTitle type string
      • m_sFirstName type string
      • m_sSurName type string
      • m_sUnitName type string
      • m_sAddress type string
      • m_sEmail type string
      • m_nFbid - nillable; type int
      • m_nAddressId - nillable; type int
      • m_sPassword type string
      • m_sPhoneNumber type string
      • m_aCourses type CourseList
        • Courses - optional, unbounded; type Course
          • m_nCourseId - nillable; type int
          • m_sProgramOfStudy type string
          • m_sCourseTitle type string
          • m_sRoom type string
          • m_nCourseType - nillable; type int
          • m_sPubCourseId type string
          • m_sExternalId type string
          • m_nCountStud - nillable; type int
          • m_aCustomFieldValues type StringList
            • Strings - optional, unbounded; type string
          • m_nUserId - nillable; type int
          • m_nFbid - nillable; type int
          • m_nPeriodId - nillable; type int
          • m_aoParticipants type PersonList
            • Persons - optional, unbounded; type Person
              • m_nId - nillable; type int
              • m_sTitle type string
              • m_sFirstname type string
              • m_sLastname type string
              • m_sIdentifier type string
              • m_sEmail type string
              • m_nGender - nillable; type int
              • m_sAddress - nillable; type int
              • m_sCustom1 type string
              • m_sCustom2 type string
              • m_sCustom3 type string
          • m_aoSecondaryInstructors type UserList
            • Users - optional, unbounded; type User
              • m_nId - nillable; type int
              • m_nType - nillable; type int
              • m_sLoginName type string
              • m_sExternalId type string
              • m_sTitle type string
              • m_sFirstName type string
              • m_sSurName type string
              • m_sUnitName type string
              • m_sAddress type string
              • m_sEmail type string
              • m_nFbid - nillable; type int
              • m_nAddressId - nillable; type int
              • m_sPassword type string
              • m_sPhoneNumber type string
              • m_aCourses type CourseList
                • Courses - optional, unbounded; type Course
                  • m_nCourseId - nillable; type int
                  • m_sProgramOfStudy type string
                  • m_sCourseTitle type string
                  • m_sRoom type string
                  • m_nCourseType - nillable; type int
                  • m_sPubCourseId type string
                  • m_sExternalId type string
                  • m_nCountStud - nillable; type int
                  • m_aCustomFieldValues type StringList
                    • Strings - optional, unbounded; type string
                  • m_nUserId - nillable; type int
                  • m_nFbid - nillable; type int
                  • m_nPeriodId - nillable; type int
                  • m_aoParticipants type PersonList
                    • Persons - optional, unbounded; type Person
                      • m_nId - nillable; type int
                      • m_sTitle type string
                      • m_sFirstname type string
                      • m_sLastname type string
                      • m_sIdentifier type string
                      • m_sEmail type string
                      • m_nGender - nillable; type int
                      • m_sAddress - nillable; type int
                      • m_sCustom1 type string
                      • m_sCustom2 type string
                      • m_sCustom3 type string
                  • m_aoSecondaryInstructors type UserList
                    • Users - optional, unbounded; type User
                      • m_nId - nillable; type int
                      • m_nType - nillable; type int
                      • m_sLoginName type string
                      • m_sExternalId type string
                      • m_sTitle type string
                      • m_sFirstName type string
                      • m_sSurName type string
                      • m_sUnitName type string
                      • m_sAddress type string
                      • m_sEmail type string
                      • m_nFbid - nillable; type int
                      • m_nAddressId - nillable; type int
                      • m_sPassword type string
                      • m_sPhoneNumber type string
                      • m_aCourses type CourseList
                        • Courses - optional, unbounded; type Course
                          • m_nCourseId - nillable; type int
                          • m_sProgramOfStudy type string
                          • m_sCourseTitle type string
                          • m_sRoom type string
                          • m_nCourseType - nillable; type int
                          • m_sPubCourseId type string
                          • m_sExternalId type string
                          • m_nCountStud - nillable; type int
                          • m_aCustomFieldValues type StringList
                            • Strings - optional, unbounded; type string
                          • m_nUserId - nillable; type int
                          • m_nFbid - nillable; type int
                          • m_nPeriodId - nillable; type int
                          • m_aoParticipants type PersonList
                            • Persons - optional, unbounded; type Person
                              • m_nId - nillable; type int
                              • m_sTitle type string
                              • m_sFirstname type string
                              • m_sLastname type string
                              • m_sIdentifier type string
                              • m_sEmail type string
                              • m_nGender - nillable; type int
                              • m_sAddress - nillable; type int
                              • m_sCustom1 type string
                              • m_sCustom2 type string
                              • m_sCustom3 type string
                          • m_aoSecondaryInstructors type UserList
                            • Users - optional, unbounded; type User ... is recursive
                          • m_oSurveyHolder type SurveyHolder
                            • m_aSurveys type SurveyList
                              • Surveys - optional, unbounded; type Survey
                                • m_nSurveyId - nillable; type int
                                • m_nState - nillable; type int
                                • m_sTitle type string
                                • m_cType type string
                                • m_nFrmid - nillable; type int
                                • m_nStuid - nillable; type int
                                • m_nVerid - nillable; type int
                                • m_nOpenState - nillable; type int
                                • m_nFormCount - nillable; type int
                                • m_nPswdCount - nillable; type int
                                • m_sLastDataCollectionDate type string
                                • m_nPageLinkOffset - nillable; type int
                                • m_sMaskTan type string
                                • m_nMaskState - nillable; type int
                                • m_oPeriod type Period
                                  • m_nPeriodId - nillable; type int
                                  • m_sTitel type string
                                  • m_sStartDate type string
                                  • m_sEndDate type string
                  • m_oSurveyHolder type SurveyHolder
                    • m_aSurveys type SurveyList
                      • Surveys - optional, unbounded; type Survey
                        • m_nSurveyId - nillable; type int
                        • m_nState - nillable; type int
                        • m_sTitle type string
                        • m_cType type string
                        • m_nFrmid - nillable; type int
                        • m_nStuid - nillable; type int
                        • m_nVerid - nillable; type int
                        • m_nOpenState - nillable; type int
                        • m_nFormCount - nillable; type int
                        • m_nPswdCount - nillable; type int
                        • m_sLastDataCollectionDate type string
                        • m_nPageLinkOffset - nillable; type int
                        • m_sMaskTan type string
                        • m_nMaskState - nillable; type int
                        • m_oPeriod type Period
                          • m_nPeriodId - nillable; type int
                          • m_sTitel type string
                          • m_sStartDate type string
                          • m_sEndDate type string
          • m_oSurveyHolder type SurveyHolder
            • m_aSurveys type SurveyList
              • Surveys - optional, unbounded; type Survey
                • m_nSurveyId - nillable; type int
                • m_nState - nillable; type int
                • m_sTitle type string
                • m_cType type string
                • m_nFrmid - nillable; type int
                • m_nStuid - nillable; type int
                • m_nVerid - nillable; type int
                • m_nOpenState - nillable; type int
                • m_nFormCount - nillable; type int
                • m_nPswdCount - nillable; type int
                • m_sLastDataCollectionDate type string
                • m_nPageLinkOffset - nillable; type int
                • m_sMaskTan type string
                • m_nMaskState - nillable; type int
                • m_oPeriod type Period
                  • m_nPeriodId - nillable; type int
                  • m_sTitel type string
                  • m_sStartDate type string
                  • m_sEndDate type string
      Output:
      InsertUserResponse (soap:body, use = literal)Source code
      User type User
      • m_nId - nillable; type int
      • m_nType - nillable; type int
      • m_sLoginName type string
      • m_sExternalId type string
      • m_sTitle type string
      • m_sFirstName type string
      • m_sSurName type string
      • m_sUnitName type string
      • m_sAddress type string
      • m_sEmail type string
      • m_nFbid - nillable; type int
      • m_nAddressId - nillable; type int
      • m_sPassword type string
      • m_sPhoneNumber type string
      • m_aCourses type CourseList
        • Courses - optional, unbounded; type Course
          • m_nCourseId - nillable; type int
          • m_sProgramOfStudy type string
          • m_sCourseTitle type string
          • m_sRoom type string
          • m_nCourseType - nillable; type int
          • m_sPubCourseId type string
          • m_sExternalId type string
          • m_nCountStud - nillable; type int
          • m_aCustomFieldValues type StringList
            • Strings - optional, unbounded; type string
          • m_nUserId - nillable; type int
          • m_nFbid - nillable; type int
          • m_nPeriodId - nillable; type int
          • m_aoParticipants type PersonList
            • Persons - optional, unbounded; type Person
              • m_nId - nillable; type int
              • m_sTitle type string
              • m_sFirstname type string
              • m_sLastname type string
              • m_sIdentifier type string
              • m_sEmail type string
              • m_nGender - nillable; type int
              • m_sAddress - nillable; type int
              • m_sCustom1 type string
              • m_sCustom2 type string
              • m_sCustom3 type string
          • m_aoSecondaryInstructors type UserList
            • Users - optional, unbounded; type User
              • m_nId - nillable; type int
              • m_nType - nillable; type int
              • m_sLoginName type string
              • m_sExternalId type string
              • m_sTitle type string
              • m_sFirstName type string
              • m_sSurName type string
              • m_sUnitName type string
              • m_sAddress type string
              • m_sEmail type string
              • m_nFbid - nillable; type int
              • m_nAddressId - nillable; type int
              • m_sPassword type string
              • m_sPhoneNumber type string
              • m_aCourses type CourseList
                • Courses - optional, unbounded; type Course
                  • m_nCourseId - nillable; type int
                  • m_sProgramOfStudy type string
                  • m_sCourseTitle type string
                  • m_sRoom type string
                  • m_nCourseType - nillable; type int
                  • m_sPubCourseId type string
                  • m_sExternalId type string
                  • m_nCountStud - nillable; type int
                  • m_aCustomFieldValues type StringList
                    • Strings - optional, unbounded; type string
                  • m_nUserId - nillable; type int
                  • m_nFbid - nillable; type int
                  • m_nPeriodId - nillable; type int
                  • m_aoParticipants type PersonList
                    • Persons - optional, unbounded; type Person
                      • m_nId - nillable; type int
                      • m_sTitle type string
                      • m_sFirstname type string
                      • m_sLastname type string
                      • m_sIdentifier type string
                      • m_sEmail type string
                      • m_nGender - nillable; type int
                      • m_sAddress - nillable; type int
                      • m_sCustom1 type string
                      • m_sCustom2 type string
                      • m_sCustom3 type string
                  • m_aoSecondaryInstructors type UserList
                    • Users - optional, unbounded; type User
                      • m_nId - nillable; type int
                      • m_nType - nillable; type int
                      • m_sLoginName type string
                      • m_sExternalId type string
                      • m_sTitle type string
                      • m_sFirstName type string
                      • m_sSurName type string
                      • m_sUnitName type string
                      • m_sAddress type string
                      • m_sEmail type string
                      • m_nFbid - nillable; type int
                      • m_nAddressId - nillable; type int
                      • m_sPassword type string
                      • m_sPhoneNumber type string
                      • m_aCourses type CourseList
                        • Courses - optional, unbounded; type Course
                          • m_nCourseId - nillable; type int
                          • m_sProgramOfStudy type string
                          • m_sCourseTitle type string
                          • m_sRoom type string
                          • m_nCourseType - nillable; type int
                          • m_sPubCourseId type string
                          • m_sExternalId type string
                          • m_nCountStud - nillable; type int
                          • m_aCustomFieldValues type StringList
                            • Strings - optional, unbounded; type string
                          • m_nUserId - nillable; type int
                          • m_nFbid - nillable; type int
                          • m_nPeriodId - nillable; type int
                          • m_aoParticipants type PersonList
                            • Persons - optional, unbounded; type Person
                              • m_nId - nillable; type int
                              • m_sTitle type string
                              • m_sFirstname type string
                              • m_sLastname type string
                              • m_sIdentifier type string
                              • m_sEmail type string
                              • m_nGender - nillable; type int
                              • m_sAddress - nillable; type int
                              • m_sCustom1 type string
                              • m_sCustom2 type string
                              • m_sCustom3 type string
                          • m_aoSecondaryInstructors type UserList
                            • Users - optional, unbounded; type User ... is recursive
                          • m_oSurveyHolder type SurveyHolder
                            • m_aSurveys type SurveyList
                              • Surveys - optional, unbounded; type Survey
                                • m_nSurveyId - nillable; type int
                                • m_nState - nillable; type int
                                • m_sTitle type string
                                • m_cType type string
                                • m_nFrmid - nillable; type int
                                • m_nStuid - nillable; type int
                                • m_nVerid - nillable; type int
                                • m_nOpenState - nillable; type int
                                • m_nFormCount - nillable; type int
                                • m_nPswdCount - nillable; type int
                                • m_sLastDataCollectionDate type string
                                • m_nPageLinkOffset - nillable; type int
                                • m_sMaskTan type string
                                • m_nMaskState - nillable; type int
                                • m_oPeriod type Period
                                  • m_nPeriodId - nillable; type int
                                  • m_sTitel type string
                                  • m_sStartDate type string
                                  • m_sEndDate type string
                  • m_oSurveyHolder type SurveyHolder
                    • m_aSurveys type SurveyList
                      • Surveys - optional, unbounded; type Survey
                        • m_nSurveyId - nillable; type int
                        • m_nState - nillable; type int
                        • m_sTitle type string
                        • m_cType type string
                        • m_nFrmid - nillable; type int
                        • m_nStuid - nillable; type int
                        • m_nVerid - nillable; type int
                        • m_nOpenState - nillable; type int
                        • m_nFormCount - nillable; type int
                        • m_nPswdCount - nillable; type int
                        • m_sLastDataCollectionDate type string
                        • m_nPageLinkOffset - nillable; type int
                        • m_sMaskTan type string
                        • m_nMaskState - nillable; type int
                        • m_oPeriod type Period
                          • m_nPeriodId - nillable; type int
                          • m_sTitel type string
                          • m_sStartDate type string
                          • m_sEndDate type string
          • m_oSurveyHolder type SurveyHolder
            • m_aSurveys type SurveyList
              • Surveys - optional, unbounded; type Survey
                • m_nSurveyId - nillable; type int
                • m_nState - nillable; type int
                • m_sTitle type string
                • m_cType type string
                • m_nFrmid - nillable; type int
                • m_nStuid - nillable; type int
                • m_nVerid - nillable; type int
                • m_nOpenState - nillable; type int
                • m_nFormCount - nillable; type int
                • m_nPswdCount - nillable; type int
                • m_sLastDataCollectionDate type string
                • m_nPageLinkOffset - nillable; type int
                • m_sMaskTan type string
                • m_nMaskState - nillable; type int
                • m_oPeriod type Period
                  • m_nPeriodId - nillable; type int
                  • m_sTitel type string
                  • m_sStartDate type string
                  • m_sEndDate type string
    60. IsPswdUnused
      Description:
      Checks whether the password shown is unused.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      IsPswdUnusedRequest (soap:header, use = literal, part = Header)Source code
      sPSWD type string
      Output:
      IsPswdUnusedResponse (soap:body, use = literal)Source code
      bPswdIsUnused type boolean
    61. ListTasks
      Description:
      Description: Returns all scheduled Tasks that fit the given criterias. Returned list can be reduced specific subunits, forms, surveys and/or users.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      ListTasksRequest (soap:header, use = literal, part = Header)Source code
      SubunitIDList type IDList
      • ID - optional, unbounded; type integer
      FormIDList type IDList
      • ID - optional, unbounded; type integer
      SurveyIDList type IDList
      • ID - optional, unbounded; type integer
      UserIDList type IDList
      • ID - optional, unbounded; type integer
      TaskTypeIDList type IDList
      • ID - optional, unbounded; type integer
      Output:
      ListTasksResponse (soap:body, use = literal)Source code
      TaskList type TaskList
      • InvitationTask - optional, unbounded; type InvitationTask
        • SurveyID type string
        • StartTime - nillable; type dateTime
        • TaskID - optional; type string
        • Status - optional; type string
        • SenderName - optional; type string
        • SenderEmail - optional; type string
        • EmailText - optional; type string
        • EmailSubject - optional; type string
      • RemindTask - optional, unbounded; type RemindTask
        • SurveyID type string
        • StartTime - nillable; type dateTime
        • TaskID - optional; type string
        • Status - optional; type string
        • SenderName - optional; type string
        • SenderEmail - optional; type string
        • EmailText - optional; type string
        • EmailSubject - optional; type string
        • RepeatAfterDays - optional, nillable; type int
      • ResponseRateTask - optional, unbounded; type ResponseRateTask
        • SurveyID type string
        • StartTime - nillable; type dateTime
        • TaskID - optional; type string
        • Status - optional; type string
        • ResponseRateValue - optional, nillable; type int
        • CalcMethod - optional, nillable; type int
        • MailToInstructor - optional; type boolean
        • MailToDean - optional; type boolean
      • CloseTask - optional, unbounded; type CloseTask
        • SurveyID type string
        • StartTime - nillable; type dateTime
        • TaskID - optional; type string
        • Status - optional; type string
        • SendReport - optional; type boolean
    62. OpenSurvey
      Description:
      Opens the survey referenced by its survey ID -> data collection is possible for this survey.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      OpenSurveyRequest (soap:header, use = literal, part = Header)Source code
      nSurveyId type int
      Output:
      OpenSurveyResponse (soap:body, use = literal)Source code
      bUpdateSuccess type boolean
    63. ReplaceAnswersToOpenQuestions
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      ReplaceAnswersToOpenQuestionsRequest (soap:header, use = literal, part = Header)Source code
      SurveyIDList type IDList
      • ID - optional, unbounded; type integer
      ItemCodeList type StringList
      • Strings - optional, unbounded; type string
      sReplaceComment type string
      Output:
      ReplaceAnswersToOpenQuestionsResponse (soap:body, use = literal)Source code
      Success type boolean
    64. RequestTicket
      Description:
      Gets a ticket string which can be used for further SOAP communication with the web server (“Ticket” in the SOAP header). Alternatively it is possible to use the credentials (“Login” + “Password”) directly in the SOAP header.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      RequestTicketRequest (soap:body, use = literal)Source code
      Login type string
      Password type string
      Output:
      RequestTicketResponse (soap:body, use = literal)Source code
      Ticket type string
    65. SetupCentralSurvey
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      SetupCentralSurveyRequest (soap:header, use = literal, part = Header)Source code
      oUser type User
      • m_nId - nillable; type int
      • m_nType - nillable; type int
      • m_sLoginName type string
      • m_sExternalId type string
      • m_sTitle type string
      • m_sFirstName type string
      • m_sSurName type string
      • m_sUnitName type string
      • m_sAddress type string
      • m_sEmail type string
      • m_nFbid - nillable; type int
      • m_nAddressId - nillable; type int
      • m_sPassword type string
      • m_sPhoneNumber type string
      • m_aCourses type CourseList
        • Courses - optional, unbounded; type Course
          • m_nCourseId - nillable; type int
          • m_sProgramOfStudy type string
          • m_sCourseTitle type string
          • m_sRoom type string
          • m_nCourseType - nillable; type int
          • m_sPubCourseId type string
          • m_sExternalId type string
          • m_nCountStud - nillable; type int
          • m_aCustomFieldValues type StringList
            • Strings - optional, unbounded; type string
          • m_nUserId - nillable; type int
          • m_nFbid - nillable; type int
          • m_nPeriodId - nillable; type int
          • m_aoParticipants type PersonList
            • Persons - optional, unbounded; type Person
              • m_nId - nillable; type int
              • m_sTitle type string
              • m_sFirstname type string
              • m_sLastname type string
              • m_sIdentifier type string
              • m_sEmail type string
              • m_nGender - nillable; type int
              • m_sAddress - nillable; type int
              • m_sCustom1 type string
              • m_sCustom2 type string
              • m_sCustom3 type string
          • m_aoSecondaryInstructors type UserList
            • Users - optional, unbounded; type User
              • m_nId - nillable; type int
              • m_nType - nillable; type int
              • m_sLoginName type string
              • m_sExternalId type string
              • m_sTitle type string
              • m_sFirstName type string
              • m_sSurName type string
              • m_sUnitName type string
              • m_sAddress type string
              • m_sEmail type string
              • m_nFbid - nillable; type int
              • m_nAddressId - nillable; type int
              • m_sPassword type string
              • m_sPhoneNumber type string
              • m_aCourses type CourseList
                • Courses - optional, unbounded; type Course
                  • m_nCourseId - nillable; type int
                  • m_sProgramOfStudy type string
                  • m_sCourseTitle type string
                  • m_sRoom type string
                  • m_nCourseType - nillable; type int
                  • m_sPubCourseId type string
                  • m_sExternalId type string
                  • m_nCountStud - nillable; type int
                  • m_aCustomFieldValues type StringList
                    • Strings - optional, unbounded; type string
                  • m_nUserId - nillable; type int
                  • m_nFbid - nillable; type int
                  • m_nPeriodId - nillable; type int
                  • m_aoParticipants type PersonList
                    • Persons - optional, unbounded; type Person
                      • m_nId - nillable; type int
                      • m_sTitle type string
                      • m_sFirstname type string
                      • m_sLastname type string
                      • m_sIdentifier type string
                      • m_sEmail type string
                      • m_nGender - nillable; type int
                      • m_sAddress - nillable; type int
                      • m_sCustom1 type string
                      • m_sCustom2 type string
                      • m_sCustom3 type string
                  • m_aoSecondaryInstructors type UserList
                    • Users - optional, unbounded; type User
                      • m_nId - nillable; type int
                      • m_nType - nillable; type int
                      • m_sLoginName type string
                      • m_sExternalId type string
                      • m_sTitle type string
                      • m_sFirstName type string
                      • m_sSurName type string
                      • m_sUnitName type string
                      • m_sAddress type string
                      • m_sEmail type string
                      • m_nFbid - nillable; type int
                      • m_nAddressId - nillable; type int
                      • m_sPassword type string
                      • m_sPhoneNumber type string
                      • m_aCourses type CourseList
                        • Courses - optional, unbounded; type Course
                          • m_nCourseId - nillable; type int
                          • m_sProgramOfStudy type string
                          • m_sCourseTitle type string
                          • m_sRoom type string
                          • m_nCourseType - nillable; type int
                          • m_sPubCourseId type string
                          • m_sExternalId type string
                          • m_nCountStud - nillable; type int
                          • m_aCustomFieldValues type StringList
                            • Strings - optional, unbounded; type string
                          • m_nUserId - nillable; type int
                          • m_nFbid - nillable; type int
                          • m_nPeriodId - nillable; type int
                          • m_aoParticipants type PersonList
                            • Persons - optional, unbounded; type Person
                              • m_nId - nillable; type int
                              • m_sTitle type string
                              • m_sFirstname type string
                              • m_sLastname type string
                              • m_sIdentifier type string
                              • m_sEmail type string
                              • m_nGender - nillable; type int
                              • m_sAddress - nillable; type int
                              • m_sCustom1 type string
                              • m_sCustom2 type string
                              • m_sCustom3 type string
                          • m_aoSecondaryInstructors type UserList
                            • Users - optional, unbounded; type User ... is recursive
                          • m_oSurveyHolder type SurveyHolder
                            • m_aSurveys type SurveyList
                              • Surveys - optional, unbounded; type Survey
                                • m_nSurveyId - nillable; type int
                                • m_nState - nillable; type int
                                • m_sTitle type string
                                • m_cType type string
                                • m_nFrmid - nillable; type int
                                • m_nStuid - nillable; type int
                                • m_nVerid - nillable; type int
                                • m_nOpenState - nillable; type int
                                • m_nFormCount - nillable; type int
                                • m_nPswdCount - nillable; type int
                                • m_sLastDataCollectionDate type string
                                • m_nPageLinkOffset - nillable; type int
                                • m_sMaskTan type string
                                • m_nMaskState - nillable; type int
                                • m_oPeriod type Period
                                  • m_nPeriodId - nillable; type int
                                  • m_sTitel type string
                                  • m_sStartDate type string
                                  • m_sEndDate type string
                  • m_oSurveyHolder type SurveyHolder
                    • m_aSurveys type SurveyList
                      • Surveys - optional, unbounded; type Survey
                        • m_nSurveyId - nillable; type int
                        • m_nState - nillable; type int
                        • m_sTitle type string
                        • m_cType type string
                        • m_nFrmid - nillable; type int
                        • m_nStuid - nillable; type int
                        • m_nVerid - nillable; type int
                        • m_nOpenState - nillable; type int
                        • m_nFormCount - nillable; type int
                        • m_nPswdCount - nillable; type int
                        • m_sLastDataCollectionDate type string
                        • m_nPageLinkOffset - nillable; type int
                        • m_sMaskTan type string
                        • m_nMaskState - nillable; type int
                        • m_oPeriod type Period
                          • m_nPeriodId - nillable; type int
                          • m_sTitel type string
                          • m_sStartDate type string
                          • m_sEndDate type string
          • m_oSurveyHolder type SurveyHolder
            • m_aSurveys type SurveyList
              • Surveys - optional, unbounded; type Survey
                • m_nSurveyId - nillable; type int
                • m_nState - nillable; type int
                • m_sTitle type string
                • m_cType type string
                • m_nFrmid - nillable; type int
                • m_nStuid - nillable; type int
                • m_nVerid - nillable; type int
                • m_nOpenState - nillable; type int
                • m_nFormCount - nillable; type int
                • m_nPswdCount - nillable; type int
                • m_sLastDataCollectionDate type string
                • m_nPageLinkOffset - nillable; type int
                • m_sMaskTan type string
                • m_nMaskState - nillable; type int
                • m_oPeriod type Period
                  • m_nPeriodId - nillable; type int
                  • m_sTitel type string
                  • m_sStartDate type string
                  • m_sEndDate type string
      oCourse type Course
      • m_nCourseId - nillable; type int
      • m_sProgramOfStudy type string
      • m_sCourseTitle type string
      • m_sRoom type string
      • m_nCourseType - nillable; type int
      • m_sPubCourseId type string
      • m_sExternalId type string
      • m_nCountStud - nillable; type int
      • m_aCustomFieldValues type StringList
        • Strings - optional, unbounded; type string
      • m_nUserId - nillable; type int
      • m_nFbid - nillable; type int
      • m_nPeriodId - nillable; type int
      • m_aoParticipants type PersonList
        • Persons - optional, unbounded; type Person
          • m_nId - nillable; type int
          • m_sTitle type string
          • m_sFirstname type string
          • m_sLastname type string
          • m_sIdentifier type string
          • m_sEmail type string
          • m_nGender - nillable; type int
          • m_sAddress - nillable; type int
          • m_sCustom1 type string
          • m_sCustom2 type string
          • m_sCustom3 type string
      • m_aoSecondaryInstructors type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course ... is recursive
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
      • m_oSurveyHolder type SurveyHolder
        • m_aSurveys type SurveyList
          • Surveys - optional, unbounded; type Survey
            • m_nSurveyId - nillable; type int
            • m_nState - nillable; type int
            • m_sTitle type string
            • m_cType type string
            • m_nFrmid - nillable; type int
            • m_nStuid - nillable; type int
            • m_nVerid - nillable; type int
            • m_nOpenState - nillable; type int
            • m_nFormCount - nillable; type int
            • m_nPswdCount - nillable; type int
            • m_sLastDataCollectionDate type string
            • m_nPageLinkOffset - nillable; type int
            • m_sMaskTan type string
            • m_nMaskState - nillable; type int
            • m_oPeriod type Period
              • m_nPeriodId - nillable; type int
              • m_sTitel type string
              • m_sStartDate type string
              • m_sEndDate type string
      oSubunit type Unit
      • m_nId - nillable; type int
      • m_sName type string
      • m_nPublicUnitNumber - nillable; type int
      • m_nImageAccess - nillable; type int
      • m_aUsers type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course
                              • m_nCourseId - nillable; type int
                              • m_sProgramOfStudy type string
                              • m_sCourseTitle type string
                              • m_sRoom type string
                              • m_nCourseType - nillable; type int
                              • m_sPubCourseId type string
                              • m_sExternalId type string
                              • m_nCountStud - nillable; type int
                              • m_aCustomFieldValues type StringList
                                • Strings - optional, unbounded; type string
                              • m_nUserId - nillable; type int
                              • m_nFbid - nillable; type int
                              • m_nPeriodId - nillable; type int
                              • m_aoParticipants type PersonList
                                • Persons - optional, unbounded; type Person
                                  • m_nId - nillable; type int
                                  • m_sTitle type string
                                  • m_sFirstname type string
                                  • m_sLastname type string
                                  • m_sIdentifier type string
                                  • m_sEmail type string
                                  • m_nGender - nillable; type int
                                  • m_sAddress - nillable; type int
                                  • m_sCustom1 type string
                                  • m_sCustom2 type string
                                  • m_sCustom3 type string
                              • m_aoSecondaryInstructors type UserList ... is recursive
                              • m_oSurveyHolder type SurveyHolder
                                • m_aSurveys type SurveyList
                                  • Surveys - optional, unbounded; type Survey
                                    • m_nSurveyId - nillable; type int
                                    • m_nState - nillable; type int
                                    • m_sTitle type string
                                    • m_cType type string
                                    • m_nFrmid - nillable; type int
                                    • m_nStuid - nillable; type int
                                    • m_nVerid - nillable; type int
                                    • m_nOpenState - nillable; type int
                                    • m_nFormCount - nillable; type int
                                    • m_nPswdCount - nillable; type int
                                    • m_sLastDataCollectionDate type string
                                    • m_nPageLinkOffset - nillable; type int
                                    • m_sMaskTan type string
                                    • m_nMaskState - nillable; type int
                                    • m_oPeriod type Period
                                      • m_nPeriodId - nillable; type int
                                      • m_sTitel type string
                                      • m_sStartDate type string
                                      • m_sEndDate type string
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
      nFormId type int
      nPeriodId type int
      sSurveyType type string
      sNotice type string
      Output:
      SetupCentralSurveyResponse (soap:body, use = literal)Source code
      Survey type Survey
      • m_nSurveyId - nillable; type int
      • m_nState - nillable; type int
      • m_sTitle type string
      • m_cType type string
      • m_nFrmid - nillable; type int
      • m_nStuid - nillable; type int
      • m_nVerid - nillable; type int
      • m_nOpenState - nillable; type int
      • m_nFormCount - nillable; type int
      • m_nPswdCount - nillable; type int
      • m_sLastDataCollectionDate type string
      • m_nPageLinkOffset - nillable; type int
      • m_sMaskTan type string
      • m_nMaskState - nillable; type int
      • m_oPeriod type Period
        • m_nPeriodId - nillable; type int
        • m_sTitel type string
        • m_sStartDate type string
        • m_sEndDate type string
    66. UpdateCloseTask
      Description:
      Store the changes made to the CloseTask in the database.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UpdateCloseTaskRequest (soap:header, use = literal, part = Header)Source code
      CloseTask type CloseTask
      • SurveyID type string
      • StartTime - nillable; type dateTime
      • TaskID - optional; type string
      • Status - optional; type string
      • SendReport - optional; type boolean
      Output:
      UpdateCloseTaskResponse (soap:body, use = literal)Source code
      TaskId type int
    67. UpdateCourse
      Description:
      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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UpdateCourseRequest (soap:header, use = literal, part = Header)Source code
      Course type Course
      • m_nCourseId - nillable; type int
      • m_sProgramOfStudy type string
      • m_sCourseTitle type string
      • m_sRoom type string
      • m_nCourseType - nillable; type int
      • m_sPubCourseId type string
      • m_sExternalId type string
      • m_nCountStud - nillable; type int
      • m_aCustomFieldValues type StringList
        • Strings - optional, unbounded; type string
      • m_nUserId - nillable; type int
      • m_nFbid - nillable; type int
      • m_nPeriodId - nillable; type int
      • m_aoParticipants type PersonList
        • Persons - optional, unbounded; type Person
          • m_nId - nillable; type int
          • m_sTitle type string
          • m_sFirstname type string
          • m_sLastname type string
          • m_sIdentifier type string
          • m_sEmail type string
          • m_nGender - nillable; type int
          • m_sAddress - nillable; type int
          • m_sCustom1 type string
          • m_sCustom2 type string
          • m_sCustom3 type string
      • m_aoSecondaryInstructors type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course ... is recursive
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
      • m_oSurveyHolder type SurveyHolder
        • m_aSurveys type SurveyList
          • Surveys - optional, unbounded; type Survey
            • m_nSurveyId - nillable; type int
            • m_nState - nillable; type int
            • m_sTitle type string
            • m_cType type string
            • m_nFrmid - nillable; type int
            • m_nStuid - nillable; type int
            • m_nVerid - nillable; type int
            • m_nOpenState - nillable; type int
            • m_nFormCount - nillable; type int
            • m_nPswdCount - nillable; type int
            • m_sLastDataCollectionDate type string
            • m_nPageLinkOffset - nillable; type int
            • m_sMaskTan type string
            • m_nMaskState - nillable; type int
            • m_oPeriod type Period
              • m_nPeriodId - nillable; type int
              • m_sTitel type string
              • m_sStartDate type string
              • m_sEndDate type string
      DeleteExistingParticipants type boolean
      Output:
      UpdateCourseResponse (soap:body, use = literal)Source code
      Course type Course
      • m_nCourseId - nillable; type int
      • m_sProgramOfStudy type string
      • m_sCourseTitle type string
      • m_sRoom type string
      • m_nCourseType - nillable; type int
      • m_sPubCourseId type string
      • m_sExternalId type string
      • m_nCountStud - nillable; type int
      • m_aCustomFieldValues type StringList
        • Strings - optional, unbounded; type string
      • m_nUserId - nillable; type int
      • m_nFbid - nillable; type int
      • m_nPeriodId - nillable; type int
      • m_aoParticipants type PersonList
        • Persons - optional, unbounded; type Person
          • m_nId - nillable; type int
          • m_sTitle type string
          • m_sFirstname type string
          • m_sLastname type string
          • m_sIdentifier type string
          • m_sEmail type string
          • m_nGender - nillable; type int
          • m_sAddress - nillable; type int
          • m_sCustom1 type string
          • m_sCustom2 type string
          • m_sCustom3 type string
      • m_aoSecondaryInstructors type UserList
        • Users - optional, unbounded; type User
          • m_nId - nillable; type int
          • m_nType - nillable; type int
          • m_sLoginName type string
          • m_sExternalId type string
          • m_sTitle type string
          • m_sFirstName type string
          • m_sSurName type string
          • m_sUnitName type string
          • m_sAddress type string
          • m_sEmail type string
          • m_nFbid - nillable; type int
          • m_nAddressId - nillable; type int
          • m_sPassword type string
          • m_sPhoneNumber type string
          • m_aCourses type CourseList
            • Courses - optional, unbounded; type Course
              • m_nCourseId - nillable; type int
              • m_sProgramOfStudy type string
              • m_sCourseTitle type string
              • m_sRoom type string
              • m_nCourseType - nillable; type int
              • m_sPubCourseId type string
              • m_sExternalId type string
              • m_nCountStud - nillable; type int
              • m_aCustomFieldValues type StringList
                • Strings - optional, unbounded; type string
              • m_nUserId - nillable; type int
              • m_nFbid - nillable; type int
              • m_nPeriodId - nillable; type int
              • m_aoParticipants type PersonList
                • Persons - optional, unbounded; type Person
                  • m_nId - nillable; type int
                  • m_sTitle type string
                  • m_sFirstname type string
                  • m_sLastname type string
                  • m_sIdentifier type string
                  • m_sEmail type string
                  • m_nGender - nillable; type int
                  • m_sAddress - nillable; type int
                  • m_sCustom1 type string
                  • m_sCustom2 type string
                  • m_sCustom3 type string
              • m_aoSecondaryInstructors type UserList
                • Users - optional, unbounded; type User
                  • m_nId - nillable; type int
                  • m_nType - nillable; type int
                  • m_sLoginName type string
                  • m_sExternalId type string
                  • m_sTitle type string
                  • m_sFirstName type string
                  • m_sSurName type string
                  • m_sUnitName type string
                  • m_sAddress type string
                  • m_sEmail type string
                  • m_nFbid - nillable; type int
                  • m_nAddressId - nillable; type int
                  • m_sPassword type string
                  • m_sPhoneNumber type string
                  • m_aCourses type CourseList
                    • Courses - optional, unbounded; type Course
                      • m_nCourseId - nillable; type int
                      • m_sProgramOfStudy type string
                      • m_sCourseTitle type string
                      • m_sRoom type string
                      • m_nCourseType - nillable; type int
                      • m_sPubCourseId type string
                      • m_sExternalId type string
                      • m_nCountStud - nillable; type int
                      • m_aCustomFieldValues type StringList
                        • Strings - optional, unbounded; type string
                      • m_nUserId - nillable; type int
                      • m_nFbid - nillable; type int
                      • m_nPeriodId - nillable; type int
                      • m_aoParticipants type PersonList
                        • Persons - optional, unbounded; type Person
                          • m_nId - nillable; type int
                          • m_sTitle type string
                          • m_sFirstname type string
                          • m_sLastname type string
                          • m_sIdentifier type string
                          • m_sEmail type string
                          • m_nGender - nillable; type int
                          • m_sAddress - nillable; type int
                          • m_sCustom1 type string
                          • m_sCustom2 type string
                          • m_sCustom3 type string
                      • m_aoSecondaryInstructors type UserList
                        • Users - optional, unbounded; type User
                          • m_nId - nillable; type int
                          • m_nType - nillable; type int
                          • m_sLoginName type string
                          • m_sExternalId type string
                          • m_sTitle type string
                          • m_sFirstName type string
                          • m_sSurName type string
                          • m_sUnitName type string
                          • m_sAddress type string
                          • m_sEmail type string
                          • m_nFbid - nillable; type int
                          • m_nAddressId - nillable; type int
                          • m_sPassword type string
                          • m_sPhoneNumber type string
                          • m_aCourses type CourseList
                            • Courses - optional, unbounded; type Course ... is recursive
                      • m_oSurveyHolder type SurveyHolder
                        • m_aSurveys type SurveyList
                          • Surveys - optional, unbounded; type Survey
                            • m_nSurveyId - nillable; type int
                            • m_nState - nillable; type int
                            • m_sTitle type string
                            • m_cType type string
                            • m_nFrmid - nillable; type int
                            • m_nStuid - nillable; type int
                            • m_nVerid - nillable; type int
                            • m_nOpenState - nillable; type int
                            • m_nFormCount - nillable; type int
                            • m_nPswdCount - nillable; type int
                            • m_sLastDataCollectionDate type string
                            • m_nPageLinkOffset - nillable; type int
                            • m_sMaskTan type string
                            • m_nMaskState - nillable; type int
                            • m_oPeriod type Period
                              • m_nPeriodId - nillable; type int
                              • m_sTitel type string
                              • m_sStartDate type string
                              • m_sEndDate type string
              • m_oSurveyHolder type SurveyHolder
                • m_aSurveys type SurveyList
                  • Surveys - optional, unbounded; type Survey
                    • m_nSurveyId - nillable; type int
                    • m_nState - nillable; type int
                    • m_sTitle type string
                    • m_cType type string
                    • m_nFrmid - nillable; type int
                    • m_nStuid - nillable; type int
                    • m_nVerid - nillable; type int
                    • m_nOpenState - nillable; type int
                    • m_nFormCount - nillable; type int
                    • m_nPswdCount - nillable; type int
                    • m_sLastDataCollectionDate type string
                    • m_nPageLinkOffset - nillable; type int
                    • m_sMaskTan type string
                    • m_nMaskState - nillable; type int
                    • m_oPeriod type Period
                      • m_nPeriodId - nillable; type int
                      • m_sTitel type string
                      • m_sStartDate type string
                      • m_sEndDate type string
      • m_oSurveyHolder type SurveyHolder
        • m_aSurveys type SurveyList
          • Surveys - optional, unbounded; type Survey
            • m_nSurveyId - nillable; type int
            • m_nState - nillable; type int
            • m_sTitle type string
            • m_cType type string
            • m_nFrmid - nillable; type int
            • m_nStuid - nillable; type int
            • m_nVerid - nillable; type int
            • m_nOpenState - nillable; type int
            • m_nFormCount - nillable; type int
            • m_nPswdCount - nillable; type int
            • m_sLastDataCollectionDate type string
            • m_nPageLinkOffset - nillable; type int
            • m_sMaskTan type string
            • m_nMaskState - nillable; type int
            • m_oPeriod type Period
              • m_nPeriodId - nillable; type int
              • m_sTitel type string
              • m_sStartDate type string
              • m_sEndDate type string
    68. UpdateInvitationTask
      Description:
      Store the changes made to the InvitationTask in the database.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UpdateInvitationTaskRequest (soap:header, use = literal, part = Header)Source code
      InvitationTask type InvitationTask
      • SurveyID type string
      • StartTime - nillable; type dateTime
      • TaskID - optional; type string
      • Status - optional; type string
      • SenderName - optional; type string
      • SenderEmail - optional; type string
      • EmailText - optional; type string
      • EmailSubject - optional; type string
      Output:
      UpdateInvitationTaskResponse (soap:body, use = literal)Source code
      TaskId type int
    69. UpdateRemindTask
      Description:
      Store the changes made to the RemindTask in the database.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UpdateRemindTaskRequest (soap:header, use = literal, part = Header)Source code
      RemindTask type RemindTask
      • SurveyID type string
      • StartTime - nillable; type dateTime
      • TaskID - optional; type string
      • Status - optional; type string
      • SenderName - optional; type string
      • SenderEmail - optional; type string
      • EmailText - optional; type string
      • EmailSubject - optional; type string
      • RepeatAfterDays - optional, nillable; type int
      Output:
      UpdateRemindTaskResponse (soap:body, use = literal)Source code
      TaskId type int
    70. UpdateResponseRateTask
      Description:
      Updates a scheduled task type "OnlineSurveyEmailsResponseRate" in the data-base.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UpdateResponseRateTaskRequest (soap:header, use = literal, part = Header)Source code
      ResponseRateTask type ResponseRateTask
      • SurveyID type string
      • StartTime - nillable; type dateTime
      • TaskID - optional; type string
      • Status - optional; type string
      • ResponseRateValue - optional, nillable; type int
      • CalcMethod - optional, nillable; type int
      • MailToInstructor - optional; type boolean
      • MailToDean - optional; type boolean
      Output:
      UpdateResponseRateTaskResponse (soap:body, use = literal)Source code
      TaskId type int
    71. UpdateSurvey
      Description:
      Updates the displayed survey in the the system 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.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UpdateSurveyRequest (soap:header, use = literal, part = Header)Source code
      oSurvey type Survey
      • m_nSurveyId - nillable; type int
      • m_nState - nillable; type int
      • m_sTitle type string
      • m_cType type string
      • m_nFrmid - nillable; type int
      • m_nStuid - nillable; type int
      • m_nVerid - nillable; type int
      • m_nOpenState - nillable; type int
      • m_nFormCount - nillable; type int
      • m_nPswdCount - nillable; type int
      • m_sLastDataCollectionDate type string
      • m_nPageLinkOffset - nillable; type int
      • m_sMaskTan type string
      • m_nMaskState - nillable; type int
      • m_oPeriod type Period
        • m_nPeriodId - nillable; type int
        • m_sTitel type string
        • m_sStartDate type string
        • m_sEndDate type string
      Output:
      UpdateSurveyResponse (soap:body, use = literal)Source code
      bUpdateSuccess type boolean
    72. UpdateUser
      Description:
      Updates the presented the system user in the the system database. Please note: Child objects, like courses, will not be updated by this method. Please use the method “UploadSessions” for mass import/update of course and instructor data.
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UpdateUserRequest (soap:header, use = literal, part = Header)Source code
      User type User
      • m_nId - nillable; type int
      • m_nType - nillable; type int
      • m_sLoginName type string
      • m_sExternalId type string
      • m_sTitle type string
      • m_sFirstName type string
      • m_sSurName type string
      • m_sUnitName type string
      • m_sAddress type string
      • m_sEmail type string
      • m_nFbid - nillable; type int
      • m_nAddressId - nillable; type int
      • m_sPassword type string
      • m_sPhoneNumber type string
      • m_aCourses type CourseList
        • Courses - optional, unbounded; type Course
          • m_nCourseId - nillable; type int
          • m_sProgramOfStudy type string
          • m_sCourseTitle type string
          • m_sRoom type string
          • m_nCourseType - nillable; type int
          • m_sPubCourseId type string
          • m_sExternalId type string
          • m_nCountStud - nillable; type int
          • m_aCustomFieldValues type StringList
            • Strings - optional, unbounded; type string
          • m_nUserId - nillable; type int
          • m_nFbid - nillable; type int
          • m_nPeriodId - nillable; type int
          • m_aoParticipants type PersonList
            • Persons - optional, unbounded; type Person
              • m_nId - nillable; type int
              • m_sTitle type string
              • m_sFirstname type string
              • m_sLastname type string
              • m_sIdentifier type string
              • m_sEmail type string
              • m_nGender - nillable; type int
              • m_sAddress - nillable; type int
              • m_sCustom1 type string
              • m_sCustom2 type string
              • m_sCustom3 type string
          • m_aoSecondaryInstructors type UserList
            • Users - optional, unbounded; type User
              • m_nId - nillable; type int
              • m_nType - nillable; type int
              • m_sLoginName type string
              • m_sExternalId type string
              • m_sTitle type string
              • m_sFirstName type string
              • m_sSurName type string
              • m_sUnitName type string
              • m_sAddress type string
              • m_sEmail type string
              • m_nFbid - nillable; type int
              • m_nAddressId - nillable; type int
              • m_sPassword type string
              • m_sPhoneNumber type string
              • m_aCourses type CourseList
                • Courses - optional, unbounded; type Course
                  • m_nCourseId - nillable; type int
                  • m_sProgramOfStudy type string
                  • m_sCourseTitle type string
                  • m_sRoom type string
                  • m_nCourseType - nillable; type int
                  • m_sPubCourseId type string
                  • m_sExternalId type string
                  • m_nCountStud - nillable; type int
                  • m_aCustomFieldValues type StringList
                    • Strings - optional, unbounded; type string
                  • m_nUserId - nillable; type int
                  • m_nFbid - nillable; type int
                  • m_nPeriodId - nillable; type int
                  • m_aoParticipants type PersonList
                    • Persons - optional, unbounded; type Person
                      • m_nId - nillable; type int
                      • m_sTitle type string
                      • m_sFirstname type string
                      • m_sLastname type string
                      • m_sIdentifier type string
                      • m_sEmail type string
                      • m_nGender - nillable; type int
                      • m_sAddress - nillable; type int
                      • m_sCustom1 type string
                      • m_sCustom2 type string
                      • m_sCustom3 type string
                  • m_aoSecondaryInstructors type UserList
                    • Users - optional, unbounded; type User
                      • m_nId - nillable; type int
                      • m_nType - nillable; type int
                      • m_sLoginName type string
                      • m_sExternalId type string
                      • m_sTitle type string
                      • m_sFirstName type string
                      • m_sSurName type string
                      • m_sUnitName type string
                      • m_sAddress type string
                      • m_sEmail type string
                      • m_nFbid - nillable; type int
                      • m_nAddressId - nillable; type int
                      • m_sPassword type string
                      • m_sPhoneNumber type string
                      • m_aCourses type CourseList
                        • Courses - optional, unbounded; type Course
                          • m_nCourseId - nillable; type int
                          • m_sProgramOfStudy type string
                          • m_sCourseTitle type string
                          • m_sRoom type string
                          • m_nCourseType - nillable; type int
                          • m_sPubCourseId type string
                          • m_sExternalId type string
                          • m_nCountStud - nillable; type int
                          • m_aCustomFieldValues type StringList
                            • Strings - optional, unbounded; type string
                          • m_nUserId - nillable; type int
                          • m_nFbid - nillable; type int
                          • m_nPeriodId - nillable; type int
                          • m_aoParticipants type PersonList
                            • Persons - optional, unbounded; type Person
                              • m_nId - nillable; type int
                              • m_sTitle type string
                              • m_sFirstname type string
                              • m_sLastname type string
                              • m_sIdentifier type string
                              • m_sEmail type string
                              • m_nGender - nillable; type int
                              • m_sAddress - nillable; type int
                              • m_sCustom1 type string
                              • m_sCustom2 type string
                              • m_sCustom3 type string
                          • m_aoSecondaryInstructors type UserList
                            • Users - optional, unbounded; type User ... is recursive
                          • m_oSurveyHolder type SurveyHolder
                            • m_aSurveys type SurveyList
                              • Surveys - optional, unbounded; type Survey
                                • m_nSurveyId - nillable; type int
                                • m_nState - nillable; type int
                                • m_sTitle type string
                                • m_cType type string
                                • m_nFrmid - nillable; type int
                                • m_nStuid - nillable; type int
                                • m_nVerid - nillable; type int
                                • m_nOpenState - nillable; type int
                                • m_nFormCount - nillable; type int
                                • m_nPswdCount - nillable; type int
                                • m_sLastDataCollectionDate type string
                                • m_nPageLinkOffset - nillable; type int
                                • m_sMaskTan type string
                                • m_nMaskState - nillable; type int
                                • m_oPeriod type Period
                                  • m_nPeriodId - nillable; type int
                                  • m_sTitel type string
                                  • m_sStartDate type string
                                  • m_sEndDate type string
                  • m_oSurveyHolder type SurveyHolder
                    • m_aSurveys type SurveyList
                      • Surveys - optional, unbounded; type Survey
                        • m_nSurveyId - nillable; type int
                        • m_nState - nillable; type int
                        • m_sTitle type string
                        • m_cType type string
                        • m_nFrmid - nillable; type int
                        • m_nStuid - nillable; type int
                        • m_nVerid - nillable; type int
                        • m_nOpenState - nillable; type int
                        • m_nFormCount - nillable; type int
                        • m_nPswdCount - nillable; type int
                        • m_sLastDataCollectionDate type string
                        • m_nPageLinkOffset - nillable; type int
                        • m_sMaskTan type string
                        • m_nMaskState - nillable; type int
                        • m_oPeriod type Period
                          • m_nPeriodId - nillable; type int
                          • m_sTitel type string
                          • m_sStartDate type string
                          • m_sEndDate type string
          • m_oSurveyHolder type SurveyHolder
            • m_aSurveys type SurveyList
              • Surveys - optional, unbounded; type Survey
                • m_nSurveyId - nillable; type int
                • m_nState - nillable; type int
                • m_sTitle type string
                • m_cType type string
                • m_nFrmid - nillable; type int
                • m_nStuid - nillable; type int
                • m_nVerid - nillable; type int
                • m_nOpenState - nillable; type int
                • m_nFormCount - nillable; type int
                • m_nPswdCount - nillable; type int
                • m_sLastDataCollectionDate type string
                • m_nPageLinkOffset - nillable; type int
                • m_sMaskTan type string
                • m_nMaskState - nillable; type int
                • m_oPeriod type Period
                  • m_nPeriodId - nillable; type int
                  • m_sTitel type string
                  • m_sStartDate type string
                  • m_sEndDate type string
      Output:
      UpdateUserResponse (soap:body, use = literal)Source code
      User type User
      • m_nId - nillable; type int
      • m_nType - nillable; type int
      • m_sLoginName type string
      • m_sExternalId type string
      • m_sTitle type string
      • m_sFirstName type string
      • m_sSurName type string
      • m_sUnitName type string
      • m_sAddress type string
      • m_sEmail type string
      • m_nFbid - nillable; type int
      • m_nAddressId - nillable; type int
      • m_sPassword type string
      • m_sPhoneNumber type string
      • m_aCourses type CourseList
        • Courses - optional, unbounded; type Course
          • m_nCourseId - nillable; type int
          • m_sProgramOfStudy type string
          • m_sCourseTitle type string
          • m_sRoom type string
          • m_nCourseType - nillable; type int
          • m_sPubCourseId type string
          • m_sExternalId type string
          • m_nCountStud - nillable; type int
          • m_aCustomFieldValues type StringList
            • Strings - optional, unbounded; type string
          • m_nUserId - nillable; type int
          • m_nFbid - nillable; type int
          • m_nPeriodId - nillable; type int
          • m_aoParticipants type PersonList
            • Persons - optional, unbounded; type Person
              • m_nId - nillable; type int
              • m_sTitle type string
              • m_sFirstname type string
              • m_sLastname type string
              • m_sIdentifier type string
              • m_sEmail type string
              • m_nGender - nillable; type int
              • m_sAddress - nillable; type int
              • m_sCustom1 type string
              • m_sCustom2 type string
              • m_sCustom3 type string
          • m_aoSecondaryInstructors type UserList
            • Users - optional, unbounded; type User
              • m_nId - nillable; type int
              • m_nType - nillable; type int
              • m_sLoginName type string
              • m_sExternalId type string
              • m_sTitle type string
              • m_sFirstName type string
              • m_sSurName type string
              • m_sUnitName type string
              • m_sAddress type string
              • m_sEmail type string
              • m_nFbid - nillable; type int
              • m_nAddressId - nillable; type int
              • m_sPassword type string
              • m_sPhoneNumber type string
              • m_aCourses type CourseList
                • Courses - optional, unbounded; type Course
                  • m_nCourseId - nillable; type int
                  • m_sProgramOfStudy type string
                  • m_sCourseTitle type string
                  • m_sRoom type string
                  • m_nCourseType - nillable; type int
                  • m_sPubCourseId type string
                  • m_sExternalId type string
                  • m_nCountStud - nillable; type int
                  • m_aCustomFieldValues type StringList
                    • Strings - optional, unbounded; type string
                  • m_nUserId - nillable; type int
                  • m_nFbid - nillable; type int
                  • m_nPeriodId - nillable; type int
                  • m_aoParticipants type PersonList
                    • Persons - optional, unbounded; type Person
                      • m_nId - nillable; type int
                      • m_sTitle type string
                      • m_sFirstname type string
                      • m_sLastname type string
                      • m_sIdentifier type string
                      • m_sEmail type string
                      • m_nGender - nillable; type int
                      • m_sAddress - nillable; type int
                      • m_sCustom1 type string
                      • m_sCustom2 type string
                      • m_sCustom3 type string
                  • m_aoSecondaryInstructors type UserList
                    • Users - optional, unbounded; type User
                      • m_nId - nillable; type int
                      • m_nType - nillable; type int
                      • m_sLoginName type string
                      • m_sExternalId type string
                      • m_sTitle type string
                      • m_sFirstName type string
                      • m_sSurName type string
                      • m_sUnitName type string
                      • m_sAddress type string
                      • m_sEmail type string
                      • m_nFbid - nillable; type int
                      • m_nAddressId - nillable; type int
                      • m_sPassword type string
                      • m_sPhoneNumber type string
                      • m_aCourses type CourseList
                        • Courses - optional, unbounded; type Course
                          • m_nCourseId - nillable; type int
                          • m_sProgramOfStudy type string
                          • m_sCourseTitle type string
                          • m_sRoom type string
                          • m_nCourseType - nillable; type int
                          • m_sPubCourseId type string
                          • m_sExternalId type string
                          • m_nCountStud - nillable; type int
                          • m_aCustomFieldValues type StringList
                            • Strings - optional, unbounded; type string
                          • m_nUserId - nillable; type int
                          • m_nFbid - nillable; type int
                          • m_nPeriodId - nillable; type int
                          • m_aoParticipants type PersonList
                            • Persons - optional, unbounded; type Person
                              • m_nId - nillable; type int
                              • m_sTitle type string
                              • m_sFirstname type string
                              • m_sLastname type string
                              • m_sIdentifier type string
                              • m_sEmail type string
                              • m_nGender - nillable; type int
                              • m_sAddress - nillable; type int
                              • m_sCustom1 type string
                              • m_sCustom2 type string
                              • m_sCustom3 type string
                          • m_aoSecondaryInstructors type UserList
                            • Users - optional, unbounded; type User ... is recursive
                          • m_oSurveyHolder type SurveyHolder
                            • m_aSurveys type SurveyList
                              • Surveys - optional, unbounded; type Survey
                                • m_nSurveyId - nillable; type int
                                • m_nState - nillable; type int
                                • m_sTitle type string
                                • m_cType type string
                                • m_nFrmid - nillable; type int
                                • m_nStuid - nillable; type int
                                • m_nVerid - nillable; type int
                                • m_nOpenState - nillable; type int
                                • m_nFormCount - nillable; type int
                                • m_nPswdCount - nillable; type int
                                • m_sLastDataCollectionDate type string
                                • m_nPageLinkOffset - nillable; type int
                                • m_sMaskTan type string
                                • m_nMaskState - nillable; type int
                                • m_oPeriod type Period
                                  • m_nPeriodId - nillable; type int
                                  • m_sTitel type string
                                  • m_sStartDate type string
                                  • m_sEndDate type string
                  • m_oSurveyHolder type SurveyHolder
                    • m_aSurveys type SurveyList
                      • Surveys - optional, unbounded; type Survey
                        • m_nSurveyId - nillable; type int
                        • m_nState - nillable; type int
                        • m_sTitle type string
                        • m_cType type string
                        • m_nFrmid - nillable; type int
                        • m_nStuid - nillable; type int
                        • m_nVerid - nillable; type int
                        • m_nOpenState - nillable; type int
                        • m_nFormCount - nillable; type int
                        • m_nPswdCount - nillable; type int
                        • m_sLastDataCollectionDate type string
                        • m_nPageLinkOffset - nillable; type int
                        • m_sMaskTan type string
                        • m_nMaskState - nillable; type int
                        • m_oPeriod type Period
                          • m_nPeriodId - nillable; type int
                          • m_sTitel type string
                          • m_sStartDate type string
                          • m_sEndDate type string
          • m_oSurveyHolder type SurveyHolder
            • m_aSurveys type SurveyList
              • Surveys - optional, unbounded; type Survey
                • m_nSurveyId - nillable; type int
                • m_nState - nillable; type int
                • m_sTitle type string
                • m_cType type string
                • m_nFrmid - nillable; type int
                • m_nStuid - nillable; type int
                • m_nVerid - nillable; type int
                • m_nOpenState - nillable; type int
                • m_nFormCount - nillable; type int
                • m_nPswdCount - nillable; type int
                • m_sLastDataCollectionDate type string
                • m_nPageLinkOffset - nillable; type int
                • m_sMaskTan type string
                • m_nMaskState - nillable; type int
                • m_oPeriod type Period
                  • m_nPeriodId - nillable; type int
                  • m_sTitel type string
                  • m_sStartDate type string
                  • m_sEndDate type string
    73. UploadModules
      Description:
      Uploads 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 UpdateSession 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
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UploadModulesRequest (soap:header, use = literal, part = Header)Source code
      ModuleList type ModuleList
      • Modules - unbounded; type Module
        • ModuleUid type string
        • ModuleName type string
        • ModuleCode type string
        • ModuleProgramOfStudy - optional; type string
        • ModuleEnrollment - optional, nillable; type int
        • ModuleCustomField1 - optional; type string
        • ModuleCustomField2 - optional; type string
        • ModuleCustomField3 - optional; type string
        • ModuleCustomField4 - optional; type string
        • ModuleCustomField5 - optional; type string
        • ModulePeriodId - optional; type string
        • ModulePeriodIdType - optional; type PeriodIdType - type string with restriction - enum { 'INTERNAL', 'PERIODNAME', 'PERIODDATE' }
        • ModuleSessionList type ModuleSessionList
          • ModuleSessions - unbounded; type ModuleSession
            • Uid type string
            • Name type string
            • Code type string
            • Type type string
            • ProgramOfStudy - optional; type string
            • Enrollment - optional, nillable; type int
            • CustomField1 - optional; type string
            • CustomField2 - optional; type string
            • CustomField3 - optional; type string
            • CustomField4 - optional; type string
            • CustomField5 - optional; type string
            • InstructorList type InstructorList
              • Instructors - unbounded; type Instructor
                • InstructorUid type string
                • InstructorLogin type string
                • FirstName - optional; type string
                • LastName type string
                • Title - optional; type string
                • Gender - optional; type string
                • Email - optional; type string
                • Phone - optional; type string
                • Language - optional; type string
                • IsActiveUser - optional; type string
            • RoomName - optional; type string
        • InstructorList type InstructorList
          • Instructors - unbounded; type Instructor
            • InstructorUid type string
            • InstructorLogin type string
            • FirstName - optional; type string
            • LastName type string
            • Title - optional; type string
            • Gender - optional; type string
            • Email - optional; type string
            • Phone - optional; type string
            • Language - optional; type string
            • IsActiveUser - optional; type string
        • RoomName - optional; type string
        • SubunitName type string
        • ParticipantList - optional; type PersonList
          • Persons - optional, unbounded; type Person
            • m_nId - nillable; type int
            • m_sTitle type string
            • m_sFirstname type string
            • m_sLastname type string
            • m_sIdentifier type string
            • m_sEmail type string
            • m_nGender - nillable; type int
            • m_sAddress - nillable; type int
            • m_sCustom1 type string
            • m_sCustom2 type string
            • m_sCustom3 type string
        • AnonymousParticipants - optional; type boolean
        • ModuleSurveyCreatorList - optional; type ModuleSurveyCreatorList
          • ModuleSurveyCreators - unbounded; type ModuleSurveyCreator
            • PeriodId type string
            • PeriodIdType type PeriodIdType - type string with restriction - enum { 'INTERNAL', 'PERIODNAME', 'PERIODDATE' }
            • SurveyType type SurveyType
              • m_chSurveyType type string
              • m_sDescription type string
            • Verification - optional; type boolean
            • Notice - optional; type string
            • FormRecipientList - optional; type EmailAddressList
              • EmailAddresses - optional, unbounded; type EmailAddress - type string with restriction pattern([^@]+@[^\.]+\..+)
            • InviteParticipants - optional; type boolean
            • InvitationTask - optional; type InvitationTask
              • SurveyID type string
              • StartTime - nillable; type dateTime
              • TaskID - optional; type string
              • Status - optional; type string
              • SenderName - optional; type string
              • SenderEmail - optional; type string
              • EmailText - optional; type string
              • EmailSubject - optional; type string
            • RemindTask - optional; type RemindTask
              • SurveyID type string
              • StartTime - nillable; type dateTime
              • TaskID - optional; type string
              • Status - optional; type string
              • SenderName - optional; type string
              • SenderEmail - optional; type string
              • EmailText - optional; type string
              • EmailSubject - optional; type string
              • RepeatAfterDays - optional, nillable; type int
            • ResponseRateTask - optional; type ResponseRateTask
              • SurveyID type string
              • StartTime - nillable; type dateTime
              • TaskID - optional; type string
              • Status - optional; type string
              • ResponseRateValue - optional, nillable; type int
              • CalcMethod - optional, nillable; type int
              • MailToInstructor - optional; type boolean
              • MailToDean - optional; type boolean
            • CloseTask - optional; type CloseTask
              • SurveyID type string
              • StartTime - nillable; type dateTime
              • TaskID - optional; type string
              • Status - optional; type string
              • SendReport - optional; type boolean
            • DeleteExistingSurvey - optional; type boolean
            • FormOwnerId - optional, nillable; type int
      Output:
      UploadModulesResponse (soap:body, use = literal)Source code
      UploadStatusList type UploadStatusList
      • UploadStatus - unbounded; type UploadStatus
        • CourseUid type string
        • StatusId type string
        • StatusMessage type string
        • SurveyStatusList - optional; type SurveyStatusList
          • SurveyStatusArray - optional, unbounded; type SurveyStatus
            • SurveyId - nillable; type int
            • SurveyStatus type string
            • StatusMessage type StringList
              • Strings - optional, unbounded; type string
    74. UploadSessions
      Description:
      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 in the system) 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
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UploadSessionsRequest (soap:header, use = literal, part = Header)Source code
      SessionList type SessionList
      • Sessions - unbounded; type Session
        • CourseUid type string
        • CourseName type string
        • CourseCode type string
        • CourseType type string
        • CourseProgramOfStudy - optional; type string
        • CourseEnrollment - optional, nillable; type int
        • CourseCustomField1 - optional; type string
        • CourseCustomField2 - optional; type string
        • CourseCustomField3 - optional; type string
        • CourseCustomField4 - optional; type string
        • CourseCustomField5 - optional; type string
        • CoursePeriodId - optional; type string
        • CoursePeriodIdType - optional; type PeriodIdType - type string with restriction - enum { 'INTERNAL', 'PERIODNAME', 'PERIODDATE' }
        • InstructorList type InstructorList
          • Instructors - unbounded; type Instructor
            • InstructorUid type string
            • InstructorLogin type string
            • FirstName - optional; type string
            • LastName type string
            • Title - optional; type string
            • Gender - optional; type string
            • Email - optional; type string
            • Phone - optional; type string
            • Language - optional; type string
            • IsActiveUser - optional; type string
        • RoomName - optional; type string
        • SubunitName type string
        • ParticipantList - optional; type PersonList
          • Persons - optional, unbounded; type Person
            • m_nId - nillable; type int
            • m_sTitle type string
            • m_sFirstname type string
            • m_sLastname type string
            • m_sIdentifier type string
            • m_sEmail type string
            • m_nGender - nillable; type int
            • m_sAddress - nillable; type int
            • m_sCustom1 type string
            • m_sCustom2 type string
            • m_sCustom3 type string
        • AnonymousParticipants - optional; type boolean
        • SurveyCreatorList - optional; type SurveyCreatorList
          • SurveyCreators - unbounded; type SurveyCreator
            • FormId type string
            • FormIdType type FormIdType - type string with restriction - enum { 'INTERNAL', 'FORMNAME' }
            • PeriodId type string
            • PeriodIdType type PeriodIdType - type string with restriction - enum { 'INTERNAL', 'PERIODNAME', 'PERIODDATE' }
            • SurveyType type SurveyType
              • m_chSurveyType type string
              • m_sDescription type string
            • Verification - optional; type boolean
            • Notice - optional; type string
            • FormRecipientList - optional; type EmailAddressList
              • EmailAddresses - optional, unbounded; type EmailAddress - type string with restriction pattern([^@]+@[^\.]+\..+)
            • InviteParticipants - optional; type boolean
            • InvitationTask - optional; type InvitationTask
              • SurveyID type string
              • StartTime - nillable; type dateTime
              • TaskID - optional; type string
              • Status - optional; type string
              • SenderName - optional; type string
              • SenderEmail - optional; type string
              • EmailText - optional; type string
              • EmailSubject - optional; type string
            • RemindTask - optional; type RemindTask
              • SurveyID type string
              • StartTime - nillable; type dateTime
              • TaskID - optional; type string
              • Status - optional; type string
              • SenderName - optional; type string
              • SenderEmail - optional; type string
              • EmailText - optional; type string
              • EmailSubject - optional; type string
              • RepeatAfterDays - optional, nillable; type int
            • ResponseRateTask - optional; type ResponseRateTask
              • SurveyID type string
              • StartTime - nillable; type dateTime
              • TaskID - optional; type string
              • Status - optional; type string
              • ResponseRateValue - optional, nillable; type int
              • CalcMethod - optional, nillable; type int
              • MailToInstructor - optional; type boolean
              • MailToDean - optional; type boolean
            • CloseTask - optional; type CloseTask
              • SurveyID type string
              • StartTime - nillable; type dateTime
              • TaskID - optional; type string
              • Status - optional; type string
              • SendReport - optional; type boolean
            • SerialPrint - optional; type boolean
      DeleteExistingParticipants type boolean
      Output:
      UploadSessionsResponse (soap:body, use = literal)Source code
      UploadStatusList type UploadStatusList
      • UploadStatus - unbounded; type UploadStatus
        • CourseUid type string
        • StatusId type string
        • StatusMessage type string
        • SurveyStatusList - optional; type SurveyStatusList
          • SurveyStatusArray - optional, unbounded; type SurveyStatus
            • SurveyId - nillable; type int
            • SurveyStatus type string
            • StatusMessage type StringList
              • Strings - optional, unbounded; type string
    75. UploadVolumeLicense
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      urn:soap#soap
      Input:
      UploadVolumeLicenseRequest (soap:header, use = literal, part = Header)Source code
      UserId type int
      LicenseKey type string
      Output:
      UploadVolumeLicenseResponse (soap:body, use = literal)Source code
      License type VolumeLicense
      • LicenseId type int
      • LicenseVolume type int
      • LicenseCycles type int
      • LicenseStartDate type string
      • LicenseEndDate type string
      • LicenseActivityStatus type boolean
      • UsedLicenseCycles type int
      • UsedLicenseVolume type float
      • LicenseKey type string

WSDL source code

<?xml version="1.0"?>
<wsdl:definitions targetNamespace="soapserver-v60.wsdl" name="soapserver"
xmlns:tns="soapserver-v60.wsdl"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
>
<types>
<xsd:schema targetNamespace="soapserver-v60.wsdl">
<xsd:simpleType name="QuestionTypes">
<xsd:restriction base="xsd:int">
<xsd:enumeration value="0">
<xsd:annotation>
<xsd:documentation>Scaled Question</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="2">
<xsd:annotation>
<xsd:documentation>Open Question</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="4">
<xsd:annotation>
<xsd:documentation>Grade Question</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="6">
<xsd:annotation>
<xsd:documentation>Single Choice Question</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="8">
<xsd:annotation>
<xsd:documentation>Multiple Choice Question</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="10">
<xsd:annotation>
<xsd:documentation>Extended Single Choice Question</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="14">
<xsd:annotation>
<xsd:documentation>Matrix Question</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="1001">
<xsd:annotation>
<xsd:documentation>Pole Definition</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="1002">
<xsd:annotation>
<xsd:documentation>Empty Line</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="1003">
<xsd:annotation>
<xsd:documentation>Separator Line</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="1004">
<xsd:annotation>
<xsd:documentation>Text Section</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="1005">
<xsd:annotation>
<xsd:documentation>Page Break</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="1006">
<xsd:annotation>
<xsd:documentation>Extended Pole Definition</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="Session">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
<xsd:complexType name="Module">
<xsd:sequence></xsd:sequence>
</xsd:complexType>
</xsd:schema>
</types>
<portType name="SoapPort"></portType>
<binding name="Binding" type="tns:SoapPort"></binding>
</wsdl:definitions>

About wsdl-viewer.xsl

This document was generated by SAXON 9.1.0.8 from Saxonica XSLT engine. The engine processed the WSDL in XSLT 2.0 compliant mode.
This page has been generated by wsdl-viewer.xsl, version 3.1.02
Author: tomi vanek
Download at http://tomi.vanek.sk/xml/wsdl-viewer.xsl.

The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT