academyFIVE APIInstall

Actions549

• Access-groups [Beta] Actions
  • Get access group by id
  • List access groups
• Access-groups-user Actions
  • Remove access group from profile
  • List access groups for a profile
  • Assign access group to profile
• Access-tokens [Beta] Actions
  • Create access token
• Active-sessions Actions
  • Delete active session
  • List active sessions for the current user
• Active-sessions [Beta] Actions
  • Handle OIDC front-channel logout
• Addresses [Beta] Actions
  • Get address by id
  • Delete address
  • List addresses
  • Update address
  • Create address
• Admission-procedures [Beta] Actions
  • Find jobs to automatically assign applicant groups to bookings by bookingIds.
  • Create a new job to automatically assign applicant groups to bookings by bookingIds.
  • Find jobs to automatically assign applicant groups to bookings by filter.
  • Create a new job to automatically assign applicant groups to bookings by filter.
  • Get admission procedure by id
  • List admission procedures
• Application-portal-translations Actions
  • Get translations for an application portal
  • Update translations for an application portal
• Audit-logs Actions
  • Find audit log by id
  • List audit logs
• Bookings [Beta] Actions
  • Copy an existing booking to create a new one
  • Get booking by id
  • Find bookings
  • Update booking
• Booking-statistic-austria Actions
  • Find the Austrian statistics entry for a booking
  • List Austrian statistics entries with optional filters
  • Create a new Austrian statistics entry for a booking
  • Update the Austrian statistics entry for a booking
• Buildings Actions
  • Get building by id
  • Delete building
  • List buildings
  • Create building
  • Update building
• Campus-web-accessibility-settings [Beta] Actions
  • Get campus web accessibility settings by domain
  • Create or update campus web accessibility settings
• Category-information [Beta] Actions
  • Find category information by id
  • Delete category information
  • Update category information
  • List category information
  • Create new category information
• Cohorts [Beta] Actions
  • List cohorts
  • Get cohort template settings
  • Get study mode options
  • Get study section options
• Cohort-templates Actions
  • Find a cohort template.
  • Delete a cohort template
  • Find cohort templates.
  • Create a new cohort template
  • Update a cohort template
• Colors [Beta] Actions
  • Find colors that are assignable to resources.
• Companies [Beta] Actions
  • Get company by id
  • Delete company
  • List companies
  • Update company
  • Create company
• Configuration-version-manager-versions Actions
  • List available configuration tables
  • Export configuration version as JSON
  • Import configuration version into the system
  • Get configuration version by id
  • List configuration versions
  • Create configuration version (export or import)
• Configuration-version-manager-version-imports Actions
  • List configuration version import history
• Countries Actions
  • Get country by id
  • List countries
• Course-bundle-settings Actions
  • Find the course bundle settings for the given domain id.
  • Update course bundle settings by domain id.
• Course-series-lecturers [Beta] Actions
  • Retrieve a course series lecturer assignment by ID
  • Remove a lecturer from a course series
  • List course series lecturer assignments (paginated)
  • Assign a lecturer to a course series
• Course-statuses Actions
  • Find course-status.
  • Delete course-status.
  • Find course-statuses.
  • Create a new course status
  • Update a new course status
• Course-tickets Actions
  • Create a new course ticket
  • Delete a course ticket (student registration for a course session)
• Course-tickets [Beta] Actions
  • Create a new course ticket
• Course-status-relations [Beta] Actions
  • Get course status relation by id
  • Update course status relation
• Course-study-programs Actions
  • Get a course study-program assignment
  • Delete a course study-program assignment
  • List course study-program assignments
  • Create a course study-program assignment
  • Update a course study-program assignment
  • List course study-program assignment reports
  • Assign a course study program to the course version
• Curricula Actions
  • Find curricula.
• Curriculum-entries [Beta] Actions
  • Find a curriculum entry by ID
  • Delete a curriculum entry
  • Find curriculum entries
  • Create a curriculum entry
  • Update a curriculum entry
• Curriculum-entries Actions
  • Returns the prerequisite-category candidate tree for a category curriculum entry.
  • Replaces the prerequisite categories for a category curriculum entry.
• Custom-translations [Beta] Actions
  • Find custom translations.
• Data-source-areas [Beta] Actions
  • Find a data source area by ID
  • List data source areas
  • Create a data source area
  • Update a data source area
• Data-source-field-option-group-restrictions [Beta] Actions
  • Retrieve a data source field option group restriction by ID
  • Delete a data source field option group restriction
  • List data source field option group restrictions with pagination
  • Create a new data source field option group restriction
  • Update a data source field option group restriction
• Data-source-field-option-groups [Beta] Actions
  • Retrieve a data source field option group by ID
  • Delete a data source field option group
  • List data source field option groups with pagination
  • Create a new data source field option group
  • Update a data source field option group
• Data-source-field-option-values Actions
  • Retrieve a data source field option value by ID (deprecated)
  • Delete a data source field option value
  • List data source field option values with pagination
  • Create a new data source field option value
  • Update a data source field option value
• Data-source-field-restrictions Actions
  • Get grouped data source field restrictions
  • Replace data source field restrictions.
• Data-source-fields [Beta] Actions
  • Retrieve a data source field by ID
  • List data source fields with pagination
  • Create a new data source field
  • Update a data source field
• Data-source-record-logs Actions
  • Find a data source record log by ID
  • List data source record logs
• Data-source-records Actions
  • Get data source record by id (deprecated)
  • Save or update a data source record
  • Bulk insert or update data source records
  • Bulk delete data source records (deprecated)
  • Bulk delete data source records
  • Get data source record by id
  • Update data source record
  • Create data source record
• Data-source-tab-permissions Actions
  • List data source tab permissions
• Data-source-tabs [Beta] Actions
  • Find a data source tab by ID
  • List data source tabs
  • Create a data source tab
• Data-source-exports Actions
  • Get data source export
• Data-source-permissions Actions
  • List data source permissions
• Data-sources [Beta] Actions
  • Get data source by id
  • List data sources
  • Create data source
• Database-table-columns [Beta] Actions
  • List columns of a database table
• Degrees Actions
  • Find a degree
  • Delete a degree
  • Find degrees.
  • Create a new degree
  • Update a new degree
• Document-types Actions
  • Find a document type by database ID
  • List document types with pagination and filtering
• Documents Actions
  • Generate and download a booking document PDF
  • Generate and download a building document PDF
  • Generate and download a cohort document PDF
  • Generate and download a course document PDF
  • Generate and download a course ticket document PDF
  • Generate and download a curriculum document PDF
  • Find a document template by database ID
  • List document templates filtered by entity type
  • Deprecated: generate and download a document PDF
  • Generate and download an event date document PDF
  • Generate and download an exam document PDF
  • Generate and download a grading sheet document PDF
  • Generate and download a lecturer contract document PDF
  • Generate and download a lectureship document PDF
  • Generate and download a profile document PDF
  • Generate and download a subject version document PDF
  • Generate and download a submission internship document PDF
  • Generate and download a transcript document PDF
• Emails Actions
  • Sends an email to students or staff members of the university. The delivery of the email can take up to several minutes, and only general placeholders are replaced during delivery.
• Enrolment-periods-published Actions
  • All enrolment periods will be written in one JSON object.
• Events Actions
  • List events [DEPRECATED use Event-series or Event-dates instead]
  • Create a new event [DEPRECATED use Event-series or Event-dates instead]
  • Delete an event [DEPRECATED use Event-series or Event-dates instead]
  • Update an event [DEPRECATED use Event-series or Event-dates instead]
• Event-date-user-roles Actions
  • Find an event date user role assignment by id
  • Delete an event date user role assignment by id
  • Find event date user role assignments
  • Create an event date user role assignment
• Event-dates Actions
  • Get event date by id
  • Delete event date
  • Update event date
  • List event dates for an event series
  • Add event date to event series
• Event-series Actions
  • Create custom event series with event dates
  • Update event dates of a custom event series
  • Get event series by id
  • Delete event series
  • List event series
  • Create event series
• Exam-participant-add-reports [Beta] Actions
  • Find exam-participant-add-reports
• Exam-participant-reports [Beta] Actions
  • Find exam-participant-reports
• Exam-releases [Beta] Actions
  • Release or retract exam results
• Exam-Reports [Beta] Actions
  • List exam reports
• Exams [Beta] Actions
  • Change the status of the events dates of the exams.
  • Enrol participants to an commissional exam.
  • Enrol participants to an exam.
  • Find an exam by ID
  • Delete an exam by ID
  • Find filtered and paginated exams
  • Create a new exam
  • Update an exam
  • Publish or unpublish an exam and its results
  • Change the status an exam to "open".
• Exams Actions
  • Switch the exam status from open to results entered.
• Exams-merge [Beta] Actions
  • Find exams available for merging into a target exam
  • Merge one or more exams into a target exam
• Filter-configurations [Beta] Actions
  • Get a filter configuration preset by ID
  • Delete a filter configuration preset
  • List filter configuration presets for a table
  • Create a new filter configuration preset
  • Update a filter configuration preset
• Financial-documents Actions
  • Download a cancellation document by database ID
  • Download a cancellation document by document number
  • Download a collection notice document by database ID
  • Download a collection notice document by invoice number
  • Download a first payment reminder document by database ID
  • Download a first payment reminder document by invoice number
  • Download an invoice document by database ID
  • Download an invoice document by invoice number
  • Download a refund document by database ID
  • Download a refund document by document number
  • Download a second payment reminder document by database ID
  • Download a second payment reminder document by invoice number
• Gkv-pending-messages Actions
  • List GKV pending messages
  • Create a new GKV pending message
  • Update a GKV pending message
  • Bulk update GKV pending messages
  • Assign or remove a student profile on a GKV pending message
• Global-file-syncs [Beta] Actions
  • Download the file associated with a global file sync record
  • Find a global file sync record by database ID
  • List global file sync records with pagination and filtering
  • Update a global file sync record
• Grade-annotations [Beta] Actions
  • Find a grade-annotation by id.
  • Deletes a grade annotation.
  • Find grade-annotations.
  • Create a new grade annotation.
  • Updates a grade annotation.
• Grade-annotation-relations [Beta] Actions
  • Retrieve a single grade annotation relation by its composite identifier
  • Remove the annotation linked to a grade entry
  • List grade annotation relations with optional filtering and pagination
  • Attach a grade annotation to a grade entry
• Grades [Beta] Actions
  • Find grades
• Grades Actions
  • Transfers the exam enrolment from one exam to another.
  • Find grade by grade id.
  • Deletes a grade
  • List grades
  • Create a new Grade.
  • Update a Grade.
  • Find the current job for the module grade recalculation.
  • Creates a new job to recalculate the module grades.
  • Publish or unpublish a single grade.
  • Release or unrelease a single grade.
• Health-insurance-institutes Actions
  • Find a health insurance institute by identification.
  • Delete a health insurance institute.
  • Find health insurance institutes.
  • Create a new health insurance institute.
  • Update a health insurance institute.
• Health-insurance-profiles [Beta] Actions
  • Get health insurance profile by id
  • List health insurance profiles
  • Create health insurance profile
  • Update health insurance profile
• Health-insurance-profile-communication-logs [Beta] Actions
  • Find a health insurance profile communication log by id.
  • Find health insurance profile communication log entries.
  • Create a new health insurance profile communication log entry.
  • Update a health insurance profile communication log entry.
• Health-insurance-reporting-institutes [Beta] Actions
  • Find a health insurance reporting institute by id.
  • Find health insurance reporting institutes.
• Hochschulstart-Bookings [Beta] Actions
  • Get Hochschulstart booking by id
  • Delete Hochschulstart booking
  • List Hochschulstart bookings
  • Create Hochschulstart booking
  • Update Hochschulstart booking
• Hochschulstart-events [Beta] Actions
  • Get a Hochschulstart event record by ID
  • Delete a Hochschulstart event record
  • List Hochschulstart event records
  • Create a new Hochschulstart event record
  • Update a Hochschulstart event record
• Hochschulstart-settings [Beta] Actions
  • Get a Hochschulstart settings record by ID
  • Delete a Hochschulstart settings record
  • List Hochschulstart settings records
  • Create a new Hochschulstart settings record
  • Update a Hochschulstart settings record
• Hochschulstart-settings-logs [Beta] Actions
  • Get a Hochschulstart settings log entry by ID
  • List Hochschulstart settings audit log entries
• Icons [Beta] Actions
  • Find icons that are assignable to resources.
• InvoiceCollections Actions
  • Create an invoice collection from an installment
• Invoice-number-settings [Beta] Actions
  • Get invoice number setting by id
  • Delete invoice number setting
  • Update invoice number setting
  • List invoice number settings
  • Create invoice number setting
• Invoice-queue-entries Actions
  • Creates invoice queue entries
• Invoices Actions
  • List invoices
  • Create invoice
  • Change invoice status in bulk
• Lecture-series-legible-for-booking-reports [Beta] Actions
  • Find lectureSeriesLegibleForBookingReports
• Lecturer-contract-employment-availabilities Actions
  • Retrieve a lecturer contract employment availability by ID
  • Delete a lecturer contract employment availability
  • List lecturer contract employment availabilities (paginated)
  • Create a new lecturer contract employment availability
  • Update a lecturer contract employment availability
• Lecturer-contract-employments [Beta] Actions
  • Find a lecturer contract employment by id
  • Delete a lecturer contract employment
  • List lecturer contract employments (paginated)
  • Create a new lecturer contract employment
  • Update a lecturer contract employment
• Lecturer-contracts Actions
  • Recalculate carryover.
• Lecturer-contracts [Beta] Actions
  • Retrieve a lecturer contract by ID
  • List lecturer contracts (paginated)
  • Create a new lecturer contract
  • Update a lecturer contract
• Lecturer-workload-settings [Beta] Actions
  • Find the lecturer workload settings
  • Update the lecturer workload settings
• Lecturer-lists [Beta] Actions
  • List the lecturers of a lecturer list
  • Get a lecturer list
  • Delete a lecturer list
  • Update a lecturer list
  • List lecturer lists
  • Create a lecturer list
• Lecturer-roles Actions
  • Find a lecturer role by id
  • Delete a lecturer role by id
  • Find lecturer roles
  • Create a lecturer role
  • Update a lecturer role
• Lecturers [Beta] Actions
  • List lecturers
• Maintenance [Beta] Actions
  • provides information about the cache
  • Clear cache
  • provides information about the session
• Maintenance Actions
  • status for n8n-user rabbitmq connection
  • status for rabbitmq connection
  • provides status-information about n8n
• Module-reports [Beta] Actions
  • List module reports
• Module-subject-areas [Beta] Actions
  • Retrieve a module subject area by ID
  • Delete a module subject area
  • List module subject areas
  • Create a new module subject area
  • Update a module subject area
• Module-subject-keywords [Beta] Actions
  • Retrieve a module subject keyword by ID
  • Delete a module subject keyword
  • List module subject keywords
  • Create a new module subject keyword
  • Update a module subject keyword
• Module-versions [Beta] Actions
  • Get module version by id
  • List module versions
  • Update module version
  • Create module version
• ModuleVersion Actions
  • Delete module version
• Modules [Beta] Actions
  • Get module by id
  • Delete module
  • List modules
  • Create a module
  • Update module
• N8n access-config [Beta] Actions
  • Retrieve the N8n automation server access configuration
  • Update the n8n access config
• N8n-urls [Beta] Actions
  • Retrieve the URL of the connected N8n automation server
• N8n-sessions [Beta] Actions
  • Create a new n8n session
• N8n-sso-tickets [Beta] Actions
  • Create a new n8n sso ticket
• N8n sync-jobs [Beta] Actions
  • Create a new n8n user sync job
• Navigation [Beta] Actions
  • Get the navigation areas for the current user
  • Get the navigation hubs for the current navigation area
  • Get the navigation sub hub for a campus web domain
• Notification-banners [Beta] Actions
  • Find a notification banner by id.
  • Find notification-banners
• Online-application-periods Actions
  • Bulk delete application periods
  • Find application periods (paginated)
  • Creates application period
  • Updates application period
  • Add study programs relationships to an application period
  • Remove study programs relationships from an application period
• Online-applications Actions
  • Find online applications (paginated)
• Online-exam-enrolments Actions
  • Find an online exam enrolment by id.
  • Delete an online exam enrolment.
  • Create a new online exam enrolment.
• Payments Actions
  • Records a payment against a student invoice or tuition fee.
• PaymentModelPreviews Actions
  • Generate a preview of an applicant payment model
• Process-condition-reports [Beta] Actions
  • List students with active account locks by process condition
• Process-conditions [Beta] Actions
  • Retrieve a process condition by ID
  • Delete a process condition
  • List process conditions
  • Create a new process condition
  • Update a process condition
• Professional-Backgrounds [Beta] Actions
  • Find a professional background by id.
  • Delete a professional background.
  • Find professional backgrounds.
  • Update a professional background.
  • Create a new professional background.
• Profile-bank-details [Beta] Actions
  • Get bank details for a profile
  • Delete bank details for a profile
  • List profile bank details
  • Create bank details for a profile
  • Update bank details for a profile
• Profile-duplicate-check-rules [Beta] Actions
  • Get profile duplicate check rules
  • Update profile duplicate check rules
• Profile-duplicate-reports [Beta] Actions
  • Find profile-duplicate-reports
• Profile-language-levels [Beta] Actions
  • Retrieve a profile language level by ID
  • Delete a profile language level
  • List profile language levels
  • Create a new profile language level
  • Update a profile language level
• Profiles [Beta] Actions
  • Find profile avatar by profile id.
  • Find a single profile
  • Delete profile
  • Update profile
  • Create a profile
• Profit-centers Actions
  • Creates a new profit center for financial cost tracking in university administration.
• Record-categories [Beta] Actions
  • Find a record category by ID
  • Delete a record category by ID
  • Find record categories (paginated)
  • Create a new record category
  • Update a record category
• Request-form-profile-comments Actions
  • Creates a request form profile comment object.
• Request-form-profiles Actions
  • Deletes a request form profile object.
  • Updates a request form profile object.
• Requirements [Beta] Actions
  • Get a requirement by ID
  • List requirements (paginated)
  • Create a new requirement
  • Update a requirement
• Revenue-accounts Actions
  • Get a revenue account by ID
  • Delete a revenue account
  • Create a new revenue account
  • Update a revenue account
• Revenue-accounts [Beta] Actions
  • List revenue accounts (paginated)
• Room-categories Actions
  • Find a room category by id
  • Delete a room category by id
  • Find room categories
  • Create a room category
  • Update a room category
• Room equipments Actions
  • Find room equipment by id
  • Delete a room equipment
  • Update a room equipment
  • Find room equipments
  • Create a new room equipment
• Rooms Actions
  • Get room by id
  • Delete room
  • List rooms
  • Create room
  • Update room
• Semester-terms [Beta] Actions
  • Get a semester term by ID
  • List all semester terms
  • Update a semester term
• Semester-types [Beta] Actions
  • Get semester types
• Semesters Actions
  • Find semesters (paginated)
• Sites Actions
  • Get site by id
  • List sites
• Statistic-austria Actions
  • Find the statistic austria by profile id.
• Statistic-austria [Beta] Actions
  • Create Austrian statistics data for a profile
  • Update Austrian statistics data for a profile
  • Find profile IDs with missing UHStat1 data by booking status
• Statistic-switzerland Actions
  • Find the statistic switzerland by profile id.
  • Create statistic switzerland for a profile.
  • Delete statistic switzerland for a profile.
  • Update statistic switzerland for a profile.
• Statistic-validations [Beta] Actions
  • Validate statistical reporting data for a profile
• Student-booking-statuses [Beta] Actions
  • Find student booking statuses
• Student-profiles [Beta] Actions
  • Find student profiles
• Student-semesters Actions
  • List student semesters
• Study-program-categories [Beta] Actions
  • Find study program categories.
• Study-program-curriculums [Beta] Actions
  • Get paginated list of bookings for a study program curriculum version
  • List sibling SPO versions usable as a transfer target
  • Bulk-trigger cohort curriculum transfers
  • List active transfer jobs for cohorts of a version
  • List active cohorts of a version eligible for bulk transfer
  • Find a study program curriculum
  • Delete a study program curriculum version
  • Create a study program curriculum version
  • List study program curriculum reports
• Study-programs [Beta] Actions
  • Get a study program
  • Update a study program
  • List study programs
  • Create a study program
• Subject-Reports [Beta] Actions
  • List subject reports
• Subject-version-language-levels [Beta] Actions
  • Get a subject version language level by id
  • Delete a subject version language level
  • Get a paginated list of subject version language levels
  • Create a new subject version language level
  • Update a subject version language level
• Subject-version-study-programs Actions
  • Get a subject-version-study-program assignment
  • Removes a study program assignment from a subject version
  • List subject-version-study-program assignments
  • Assigns a study program to a subject version
  • Updates a study program assignment from a subject version
• Subject-versions [Beta] Actions
  • Find a subject version by id [Beta]
  • Update a subject version [Beta]
  • Bulk assign study programs to a subject version
  • [DEPRECATED] Get a subject-version-study-program assignment
  • Removes a study program assignment from a subject version
  • List subject version study program assignments (paginated)
  • Assigns a study program to a subject version
  • Updates a study program assignment from a subject version
• Subject-Versions Actions
  • Deletes a subjectVersion
• Subjects [Beta] Actions
  • Find a subject
  • Update a subject
• Submission-assignment-types [Beta] Actions
  • Get a submission assignment type by id
  • Delete a submission assignment type
  • Get a paginated list of submission assignment types
  • Update a submission assignment type
  • Create a new submission assignment type
• Submissions Actions
  • Change the status of a submission
• Submissions [Beta] Actions
  • Update a submission
• System-configuration [Beta] Actions
  • Get the configuration of the system
• Task-comments [Beta] Actions
  • Get task comment by id
  • Delete task comment by id
  • Get paginated list of task comments
  • Create task comment
  • Update task comment
• Task-statuses [Beta] Actions
  • Find task-statuses
• Task-types [Beta] Actions
  • Find a task type by id
  • Deletes a task type
  • Find task-types
  • Create a new task type
• Task-watchers [Beta] Actions
  • Get task watcher by id
  • Delete task watcher by id
  • Get paginated list of task watchers
  • Create task watcher
• Tasks [Beta] Actions
  • List profiles assigned to tasks
  • List courses linked to tasks
  • List exams linked to tasks
  • List profiles linked to tasks
  • Get task by id
  • Delete task
  • List tasks
  • Create task
  • Update task
• Task-reports [Beta] Actions
  • List task reports
• Teaching-languages [Beta] Actions
  • Get teaching language by id
  • Delete teaching language
  • List teaching languages
  • Create teaching language
  • Update teaching language
• Translation-placeholders [Beta] Actions
  • Find translation placeholders.
• User [Beta] Actions
  • Get user settings
  • Update user settings
  • Get the user sites for the current user
  • Update the selected site id of the current user
• Userinfo [Beta] Actions
  • Get current user info
• Working-periods Actions
  • Get working period by id
  • Delete working period
  • List working periods
  • Create working period
  • Update working period
• Zensus [Beta] Actions
  • Sync course offer types from Zensus API to AC5
  • Find Zensus course-offer-types
  • Get Zensus setting by id
  • Delete Zensus setting
  • List Zensus settings
  • Create Zensus setting
  • Update Zensus setting