API functions

• SonaConvertUserToSSOByPersonID: This API converts a non-SSO user to a SSO user using the numeric person_id of the user as the identifier.
• SonaConvertUserToSSOByUserID: This API converts a non-SSO user to an SSO user using the user_id of the user as the identifier.
• SonaGetCoursesByPersonID: This API retrieves a list of all courses the participant specified by person_id is in.
• SonaSetCoursesByPersonID: This API allows overwriting or removing the course assignments for a participant specified by person_id.
• SonaGetPersonInfoByName: Returns users matching the supplied first name, last name, or both.
• SonaCreateTimeslot: This function allows creation of a timeslot programmatically via API. It returns the new timeslot’s ID and logs the event for auditing or indicates if creation wasn’t allowed.
• SonaSignUpUserToATimeslot: Signs up a participant for a specified timeslot.
• SonaGetSignUpsForTimeslot: Returns signup records for a specified timeslot.
• SonaGetSignupsByDateRange: This API retrieves the list of signup records, within a given date range.
• SonaGetStudyScheduleList: This API retrieves the list of studies within a given date range. It basically mimics the Study Schedule Report as found in the Generate Reports page of the main site.
• SonaGetStudyList: Lists studies that match the specified study-type filters.
• SonaGetResearcherIDByExperimentID: This API call retrieves the list of researchers (by person_id) for a study, based on the study’s experiment_id.
• SonaGetPrescreenSurveyDataByPersonID: This API call retrieves the list of prescreen or survey responses of a particular participant.
• SonaGetPrescreenSurveyDataByDateRange: This API retrieves the list of prescreen or survey responses, for multiple participants, based on a given date range.
• SonaGetPrescreenDataByExperimentID: Returns prescreen responses for participants with credit records for the specified study.
• SonaGetPrescreenDataByTimeslotID: Returns prescreen responses for participants signed up for the specified timeslot.
• SonaGrantCreditBySignupID: Updates the credit status and comments for one signup.
• SonaFixStudyCreditAssignmentMismatch: Corrects credit assignments that do not match study course restrictions.
• SonaGetStudyCreditAssignmentMismatch: Returns credit assignments where the assigned course is not included in the study's course restrictions.
• SonaGetPersonInfoByPersonID: Returns user information for the supplied numeric person ID.
• SonaGetPersonInfoByStudentID: Returns one participant matching the supplied student ID number.
• SonaGetPersonInfoByUserID: Returns user information for the supplied user ID.
• SonaGetPersonInfoByIDCode: Returns user information for the supplied anonymous ID code.
• SonaGetCreditBySignupID: This function will provide all information about a particular study signup, with the specified signup_id.
• SonaGetCreditsByPersonID: This function will provide information on each credit and signup for the specified participant, including non-study credit grants.
• SonaGetCreditsByTimeslotID: This function will provide information on every sign up for the specified timeslot.
• SonaGetCreditsByDateRange: This function will provide information on each credit within a given date range.
• SonaGetPersonListByClassID: This API retrieves a list of all participants in the specified course.
• SonaGetTimeslotsByExperimentID: This API retrieves a list of timeslots for a particular study.
• SonaGetTimeslotsByExperimentIDDateRange: This API retrieves the list of timeslots, for a particular study, within a given date range.
• SonaGetParticipantStats: This API retrieves basic credit and usage information (summarized) for a particular course, or all courses in the system.
• SonaGetStudyStats: This API retrieves basic usage information for a particular study. It’s similar to the Timeslot Usage Summary in the web interface.
• SonaGetStudyStatsByDateRange: This API retrieves basic usage information for a particular study, within a given date range. It’s similar to the Timeslot Usage Summary in the web interface.
• SonaGetInstructorByClassID: This API retrieves the user information for the Instructors assigned to a particular course. A course may have up to two instructors.
• SonaGetPersonListByLoginDate: Returns users filtered by user type, login permission, and last recorded login date.
• SonaGetPersonListByCreationDate: Returns users created on or after the specified date, including their user type and login permission.
• SonaGetStudyInfoByExperimentID: This function returns all information pertaining to a study based on its experiment_id.
• SonaGetStudyListByResearcher: This function returns a detailed list of studies managed by a particular researcher.
• SonaGetStudyListByPI: This function returns a detailed list of studies managed by a particular PI.
• SonaActivateUser: Activates an existing user account.
• SonaCreateUser: This function allows for the creation of a new user in the system by providing necessary details such as name, user ID, and person type.
• SonaDeactivateUser: Deactivates an existing user account.
• SonaApproveUser: Approves a participant account.
• SonaMergeUser: Merges two user accounts and transfers associated records and roles to the retained account.
• SonaSetUserTimeslotUsageLimit: Sets the Study Time Usage Limit, in participant-hours, for an existing user.
• SonaSetUserAdminComments: Appends, replaces, or deletes a user's administrator comments.
• SonaAddUserRole: Adds a researcher, principal investigator, instructor, or participant role to an existing user.
• SonaRemoveUserRole: Removes a researcher, principal investigator, instructor, or participant role from an existing user.
• WebstudyCredit: Grants credit or records participation when a participant completes an external online study.