n8n-nodes-academyfive-api 0.0.1-beta

package/dist/specs/ac5.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"academyFIVE REST Api","description":"# Introduction\n\nThis is the official REST Api documentation for [academyFive](https:\/\/de.wikipedia.org\/wiki\/AcademyFIVE).\nThe specification is using the openapi format and can be downloaded [here](\/api\/ac5.json).\n\n**\u26a0\ufe0f The Api is still under development, and some parts may change in the future, but backwards compatibility will be given.**\n\n**\u26a0\ufe0f If an endpoint is marked as \"beta\", the functionality and syntax of the endpoint may still change in future versions.**\n\n# Error handling\n\nIf your request causes any type of validation or logic error, you will get a response with the HTTP Error and a json response with a detailed \ndescription.\n\n## Example\n\nBelow is the request\n\n```yaml\nPOST \/api\/v1\/course-tickets\nAccept: application\/json\n \n{\n  \"courseLectureSeriesId\": 'a',\n  \"bookingId\": 0,\n  \"examAdmission\": false\n}\n\n```\n\nBelow is the response\n\n```yaml\nHTTP\/1.1 404 Bad Request\nContent-Type: application\/json; charset=UTF-8\n \n{\n  \"errors\": [\n    {\n      \"source\": {\n        \"pointer\": \"\/courseLectureSeriesId\"\n      },\n      \"title\": \"Invalid Attribute\",\n      \"detail\": \"courseLectureSeriesId must be a number\"\n    },\n    {\n      \"source\": {\n        \"pointer\": \"\/bookEventDates\"\n      },\n      \"title\": \"Invalid Attribute\",\n      \"detail\": \"bookEventDates is required\"\n    }\n  ]\n}\n\n```\n\n# OpenAPI Version\n\nYou can find the version of OpenAPI spec from the `version` object\n\n```yaml\n  openapi: 3.0.0\n  info:\n    version: '0.8.1'\n    title: Server Variables\n  ...  \n```\n\n# Authentication\n\nCurrently, we offer one form of authentication:\n  \n  - BasicAuth\n\nIn the future we will also support OAuth2 - an open protocol to allow secure authorization in a simple\nand standard method from the web, mobile and desktop applications.\n\n# Language\n\nIf you want to change the language, you can set the `User-Language` header to `de` for German.\nCurrently, not all endpoints support the header. Some endpoints use the default language of the a5 system.\n","version":"0.9.1"},"paths":{"\/api\/v1\/access-groups\/{accessGroupId}":{"get":{"tags":["access-groups [Beta]"],"summary":"Find an access-group by id","description":"Find an access-group by id.<br> Required permissions are: read access for access-groups.","operationId":"bffdf508b4d93adbbed7244093b4b5a4","parameters":[{"name":"accessGroupId","in":"path","description":"The access-group id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/AccessGroups\/Schema\/AccessGroupsGetSchema.json"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/access-groups":{"get":{"tags":["access-groups [Beta]"],"summary":"Find access-groups","description":"Find access-groups.<br> Required permissions are: read access for access-groups.","operationId":"49449bb501a16a27ea95862033ef3dc6","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer","example":50}},{"name":"filter[ids]","in":"query","description":"Search for a specific ids.","required":false,"schema":{"type":"string","example":"01JSKY128VS5T4JPS1E5GN5BFN,01JSKY128VS5T4JPS1E5GN5BFP,01JSKY128WW6G1K1WPAYCR5402"}},{"name":"filter[types]","in":"query","description":"Search for a specific type.","required":false,"schema":{"type":"string","example":"1,2"}},{"name":"filter[label]","in":"query","description":"Search for a specific label.","required":false,"schema":{"type":"string","example":"Author"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string","example":"ids"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/AccessGroups\/Schema\/AccessGroupsGetPaginatedSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/bookings\/{bookingId}":{"get":{"tags":["bookings [Beta]"],"summary":"Find a booking by id","description":"Find a booking by id.<br>\n    Required permissions are: read access for bookings.","operationId":"77a1df3b17ace4ebac428c5c22ca495f","parameters":[{"name":"bookingId","in":"path","description":"The booking id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/bookings":{"patch":{"tags":["bookings [Beta]"],"summary":"Update a booking","description":"Updates a booking and returns it.<br>\n    Required permissions are: write access for bookings.","operationId":"2e92cf42ed088e74299b0fa5b030f348","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Bookings\/Handler\/BookingsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/bookings\/{bookingId}\/statistic-austria":{"get":{"tags":["booking-statistic-austria"],"summary":"Find the statistic austria for a booking id.","description":"Find the statistic austria for a booking id.<br>\n    Required permissions are: Read access for statistic-austria.","operationId":"3b7a7eb874e467ce9ed9ee5589b0aa0b","parameters":[{"name":"bookingId","in":"path","description":"The booking id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/bookings\/statistic-austria":{"get":{"tags":["booking-statistic-austria"],"summary":"Find the statistic austria for bookings and dates.","description":"Find the statistic austria for bookings and dates.<br>\n    Required permissions are: Read access for statistic-austria.","operationId":"ac887b7626c3db52f603b8790720a2e1","parameters":[{"name":"filter[bookingIds]","in":"query","description":"Comma seperated list of booking ids.","required":false,"schema":{"type":"string"}},{"name":"filter[uhStat0]","in":"query","description":"Format: YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"filter[uhStat2]","in":"query","description":"Format: YYYY-MM-DD","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"post":{"tags":["booking-statistic-austria"],"summary":"Create a new statistic Austria Entry for a Booking","description":"Creates a new Booking Statistic Austria object and returns it.<br>\n     * Required permissions are: Write access for statistic-austria.","operationId":"893acf2767073611b6767015f782c970","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Bookings\/StatisticAustria\/Handler\/BookingStatisticAustriaPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["booking-statistic-austria"],"summary":"Update the statistic austria entry for a booking","description":"Update the statistic austria entry for a booking.<br>\n     * Required permissions are: Write access for statistic-austria.","operationId":"7342e3569f2997455d5cc5240907336a","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Bookings\/StatisticAustria\/Handler\/BookingStatisticAustriaPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/cohorts":{"get":{"tags":["cohorts [Beta]"],"summary":"Find cohorts","description":"Find cohorts.<br> Required permissions are: read access for cohorts.","operationId":"8a2b32d57e1a73b176c2a70c32958091","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer","example":50}},{"name":"filter[ids]","in":"query","description":"Search for a specific ids.","required":false,"schema":{"type":"string","example":"40,23,230"}},{"name":"filter[name]","in":"query","description":"Search for a specific name.","required":false,"schema":{"type":"string","example":"Cohort"}},{"name":"filter[siteIds]","in":"query","description":"Search for cohorts with specific siteIds.","required":false,"schema":{"type":"string","example":"40,23,230"}},{"name":"filter[isActive]","in":"query","description":"Filter by active status. (comma separated)","required":false,"schema":{"type":"int","example":"0,1"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string","example":"ids,-name"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Cohorts\/Schema\/CohortsGetPaginatedSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/colors":{"get":{"tags":["colors [Beta]"],"summary":"Find colors that are assignable to resources.","description":"Find colors that are assignable to resources.","operationId":"8eb54a55829841562216fd7be6175886","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Colors\/Schema\/ColorsListGetSchema.json"}}}}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/companies\/{companyId}":{"get":{"tags":["Companies [Beta]"],"summary":"Find a company by id [Beta]","operationId":"74c1536948bc2eafda11d74c0a1fd9e7","parameters":[{"name":"companyId","in":"path","description":"The company id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["Companies [Beta]"],"summary":"Delete a company by id","operationId":"a21c9de95e661b5298d7eefd750b523a","parameters":[{"name":"companyId","in":"path","description":"The company id.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/companies":{"get":{"tags":["Companies [Beta]"],"summary":"Find companies [Beta]","operationId":"c44901eeda98a18964f3423830e5b946","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific id.","required":false,"schema":{"type":"string"}},{"name":"filter[name]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"put":{"tags":["Companies [Beta]"],"summary":"Update a company [Beta]","description":"Edits a company object and returns it. Note this is a beta accesspoint: routes and parameters can change!","operationId":"4ea5707e156662f1b7bc4f8536abe06e","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Company\/Handler\/CompanyPutSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["Companies [Beta]"],"summary":"Create a new company [Beta]","description":"Creates a new company object and returns it. Note this is a beta accesspoint: routes and parameters can change!","operationId":"c1c658fba7c4b9fc755ea9b4a699f821","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Company\/Handler\/CompanyPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/countries\/{countryId}":{"get":{"tags":["Countries"],"summary":"Find a country by id","operationId":"e7d17476754d52a5cb3bb3b50bf07c92","parameters":[{"name":"countryId","in":"path","description":"The country id.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/countries":{"get":{"tags":["Countries"],"summary":"Find countries","operationId":"bd00bfaa2fa28cd8eab5b1dc78d5761e","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific id.","required":false,"schema":{"type":"integer"}},{"name":"filter[nameDe]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[nameEn]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-nameDe"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/course-series-lecturers\/{courseSeriesLecturerId}":{"get":{"tags":["course-series-lecturers [Beta]"],"summary":"Find a course series lecturer by id","operationId":"0eb4e800c28d5db9fb84ad76f05df756","parameters":[{"name":"courseSeriesLecturerId","in":"path","description":"The CourseSeriesLectuerer id. (ProfileId-CourseSeriesId)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["course-series-lecturers [Beta]"],"summary":"Delete a course series lecturer by id","operationId":"700c7f9c92972c345362ab740dcd5aa1","parameters":[{"name":"courseSeriesLecturerId","in":"path","description":"The CourseSeriesLectuerer id. (ProfileId-CourseSeriesId)","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/course-series-lecturers":{"get":{"tags":["course-series-lecturers [Beta]"],"summary":"Find courseSeriesLecturers","operationId":"870f7cc88bc228beb4d6744a0792eba4","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[lecturer]","in":"query","description":"Search for a specific profileId (comma separated).","required":false,"schema":{"type":"string"},"example":"51,130"},{"name":"filter[courseSeries]","in":"query","description":"Search for a specific courseSeriesId (comma separated).","required":false,"schema":{"type":"string"},"example":"70,92"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["course-series-lecturers [Beta]"],"summary":"Create a new courseSeriesLecturer","description":"Creates a new courseSeriesLecturer object and returns it.","operationId":"bc5cacf23cf8c40ec856aa43210e4917","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/CourseSeriesLecturer\/Handler\/CourseSeriesLecturerPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/course-tickets":{"post":{"tags":["course-tickets"],"summary":"Create a new course ticket","description":"Create a new course ticket for given student booking id and course lecture series id","operationId":"14666794da99c5f744306fd30ebf4f40","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CourseTicketAddCommand"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Invalid input"}},"deprecated":true,"security":[{"basicAuth":[]}]}},"\/api\/v1\/course-tickets\/{courseTicketId}":{"delete":{"tags":["course-tickets"],"summary":"Delete a course ticket","operationId":"6e165e564d216b1ccd24374b5d390a18","parameters":[{"name":"courseTicketId","in":"path","description":"The course ticket id","required":true,"schema":{"type":"integer","minimum":"1"}}],"responses":{"200":{"description":"No Content"},"400":{"description":"Bad Request"}},"security":[{"basicAuth":[]}]}},"\/api\/v2\/course-tickets":{"post":{"tags":["course-tickets [Beta]"],"summary":"Create a new course ticket","description":"Create a new course ticket for given student booking and course lecture series.","operationId":"15e02f13c491096bdd13d34ee0dc3662","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/CourseTicket\/Handler\/CourseTicketsPostV2Schema.json"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CourseTickets"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/course-status-relations\/{courseStatusRelationId}":{"get":{"tags":["course-status-relations [Beta]"],"summary":"Find a course status relation by id","description":"Find a course status relation by id.<br>\n    Required permissions are: read access for courses.","operationId":"559f8d390ee47bfa35bc6c48ea06efd2","parameters":[{"name":"courseStatusRelationId","in":"path","description":"The course status relation id (courseId-courseStatusId).","required":true,"schema":{"type":"string"},"example":"1-2"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["course-status-relations [Beta]"],"summary":"Update a course status relation","description":"Updates a course status relation and returns it.<br>\n    Required permissions are: write access for courses.","operationId":"f4416a3d13a743ebe1ac23a5e6022c0e","parameters":[{"name":"courseStatusRelationId","in":"path","description":"The course status relation id (courseId-courseStatusId).","required":true,"schema":{"type":"string"},"example":"1-2"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-areas\/{dataSourceAreaId}":{"get":{"tags":["data-source-areas [Beta]"],"summary":"Find a data source area by id","description":"Find a data source area by id.<br>\n    Required permissions are: read access for data-source-areas.","operationId":"73c523f75811de19e1772e68771fe693","parameters":[{"name":"dataSourceAreaId","in":"path","description":"The data source area id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-areas":{"get":{"tags":["data-source-areas [Beta]"],"summary":"Find data-source-areas","description":"Find data-source-areas.<br>\n    Required permissions are: read access for data-source-areas.","operationId":"3a70c2234dc9687b4b84fdc51e6abe30","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific id.","required":false,"schema":{"type":"string"}},{"name":"filter[name]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort areas. Default ascending, minus before area for descending.","required":false,"schema":{"type":"string"},"example":"id"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["data-source-areas [Beta]"],"summary":"Creates a data source area","description":"Creates a data source area and returns it.<br>\n    Required permissions are: write access for data-source-areas.","operationId":"001adb1e9ef73198c225798a579f3fee","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceAreas\/Handler\/DataSourceAreasPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["data-source-areas [Beta]"],"summary":"Update a data source area","description":"Updates a data source area and returns it.<br>\n    Required permissions are: write access for data-source-areas.","operationId":"27a2278769a23eda01ed58fb10e20182","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceAreas\/Handler\/DataSourceAreasPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-field-option-group-restrictions\/{restrictionId}":{"get":{"tags":["data-source-field-option-group-restrictions [Beta]"],"summary":"Find a data source field option group restriction by id","description":"Find a data source field option group by restriction id.<br>\n    Required permissions are: read access for data-source-field-option-group-restrictions.","operationId":"eb9cf4e108076f5f45487fd061de3c3d","parameters":[{"name":"restrictionId","in":"path","description":"The data source field option group restriction id.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"field,fieldOptionGroup"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["data-source-field-option-group-restrictions [Beta]"],"summary":"Deletes a data source field option group","description":"Deletes a data source field option group restriction object.<br>\n    Required permissions are: write access for data-source-field-option-group-restrictions.","operationId":"74beb6956b9e0b73c4278539d7c2e4bc","parameters":[{"name":"restrictionId","in":"path","description":"The data source field option group restriction id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-field-option-group-restrictions":{"get":{"tags":["data-source-field-option-group-restrictions [Beta]"],"summary":"Find data-source-field-option-group-restrictions","description":"Find data-source-field-option-group-restrictions.<br>\n    Required permissions are: read access for data-source-field-option-group-restrictions.","operationId":"e2e031f9deaef8ab53d7fd4f0878fbb7","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for comma separated ids.","required":false,"schema":{"type":"string"}},{"name":"filter[fieldId]","in":"query","description":"Search for comma separated field ids.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-name"},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"field,fieldOptionGroup"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["data-source-field-option-group-restrictions [Beta]"],"summary":"Create a new data source field option group restriction","description":"Creates a new data source field option group restriction object and returns it.<br>\n    Required permissions are: write access for data-source-field-option-group-restrictions.","operationId":"8e6b372a9ccd4f90c012ef1640fffa32","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceFieldOptionGroupRestrictions\/Handler\/DataSourceFieldOptionGroupRestrictionsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["data-source-field-option-group-restrictions [Beta]"],"summary":"Update a data source field option group","description":"Updates a data source field option group and returns it.<br>\n    Required permissions are: write access for data-source-field-option-group-restrictions.","operationId":"79234f2a08d917995c6623bb2a860fff","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceFieldOptionGroupRestrictions\/Handler\/DataSourceFieldOptionGroupRestrictionsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-field-option-groups\/{dataSourceFieldOptionGroupId}":{"get":{"tags":["data-source-field-option-groups [Beta]"],"summary":"Find a data source field option group by id","description":"Find a data source field option group by id.<br>\n    Required permissions are: read access for data-source-field-option-groups.","operationId":"37fe05a0f8758ccad2bdda49ce063a90","parameters":[{"name":"dataSourceFieldOptionGroupId","in":"path","description":"The data source field option group id.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"field"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["data-source-field-option-groups [Beta]"],"summary":"Deletes a data source field option group","description":"Deletes a data source field option group object.<br>\n    Required permissions are: write access for data-source-field-option-groups.","operationId":"65b4eeaf9c823701eb6c5be3be2622c3","parameters":[{"name":"dataSourceFieldOptionGroupId","in":"path","description":"The data source field option group id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-field-option-groups":{"get":{"tags":["data-source-field-option-groups [Beta]"],"summary":"Find data-source-field-option-groups","description":"Find data-source-field-option-groups.<br>\n    Required permissions are: read access for data-source-field-option-groups.","operationId":"cc4921ccac663f3fb1ee170e222202d4","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for comma separated ids.","required":false,"schema":{"type":"string"}},{"name":"filter[fieldId]","in":"query","description":"Search for comma separated field ids.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-name"},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"field"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["data-source-field-option-groups [Beta]"],"summary":"Create a new data source field option group","description":"Creates a new data source field option group object and returns it.<br>\n    Required permissions are: write access for data-source-field-option-groups.","operationId":"8ca687f7f89de667a09c9458361e1a6d","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceFieldOptionGroups\/Handler\/DataSourceFieldOptionGroupsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["data-source-field-option-groups [Beta]"],"summary":"Update a data source field option group","description":"Updates a data source field option group and returns it.<br>\n    Required permissions are: write access for data-source-field-option-groups.","operationId":"df25172a6d62123aa474d955ca2efdbe","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceFieldOptionGroups\/Handler\/DataSourceFieldOptionGroupsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-field-option-values\/{dataSourceFieldOptionValueId}":{"get":{"tags":["data-source-field-option-values"],"summary":"Find a data source field option value by id","description":"Find a data source field option value by id.<br>\n    Required permissions are: read access for data-source-field-option-values.","operationId":"5b57e88ef2088e3126b91e2c55a82af6","parameters":[{"name":"dataSourceFieldOptionValueId","in":"path","description":"The data source field option value id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["data-source-field-option-values"],"summary":"Deletes a data source field option value","description":"Deletes a data source field option value object.<br>\n    Required permissions are: write access for data-source-field-option-values.","operationId":"d4bddf3c7d856594b488af445df8cdc8","parameters":[{"name":"dataSourceFieldOptionValueId","in":"path","description":"The data source field option value id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-field-option-values":{"get":{"tags":["data-source-field-option-values"],"summary":"Find data-source-field-option-values","description":"Find data-source-field-option-values.<br>\n    Required permissions are: read access for data-source-field-option-values.","operationId":"b2813d8ead26fc2a77081f23ec5eab28","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[ids]","in":"query","description":"Search for data source field option value ids (comma separated).","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"position"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["data-source-field-option-values"],"summary":"Create a new data source field option value","description":"Creates a new data source field option value object and returns it.<br>\n    Required permissions are: write access for data-source-field-option-values.","operationId":"ea964aa3d1de58b0ee32f12158541873","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceFieldOptionValues\/Handler\/DataSourceFieldOptionValuesPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["data-source-field-option-values"],"summary":"Update a data source field option value","description":"Updates a data source field option value and returns it.<br>\n    Required permissions are: write access for data-source-field-option-values.","operationId":"b9522a8d25688a0eef85136a539fbc22","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceFieldOptionValues\/Handler\/DataSourceFieldOptionValuesPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-fields\/{dataSourceFieldId}":{"get":{"tags":["data-source-fields [Beta]"],"summary":"Find a data source field by id","description":"Find a data source field by id.<br>\n    Required permissions are: read access for data-source-fields.","operationId":"a6c8038af2cff0714135de7d178b9431","parameters":[{"name":"dataSourceFieldId","in":"path","description":"The data source field id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-fields":{"get":{"tags":["data-source-fields [Beta]"],"summary":"Find data-source-fields","description":"Find data-source-fields.<br>\n    Required permissions are: read access for data-source-fields.","operationId":"16b304623f269ad11d07553456a6ac32","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific ids (comma separated).","required":false,"schema":{"type":"string"}},{"name":"filter[name]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-name"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["data-source-fields [Beta]"],"summary":"Create a new data source field","description":"Creates a new data source field and returns it.<br>\n    Required permissions are: write access for data-source-fields.","operationId":"21d8fd822daf40aa86a612600b49a2d4","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceFields\/Handler\/DataSourceFieldsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["data-source-fields [Beta]"],"summary":"Update a data source field","description":"Updates a data source field and returns it.<br>\n    Required permissions are: write access for data-source-fields.","operationId":"6f62b2661661e6f701ea31ed1b6bfd45","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceFields\/Handler\/DataSourceFieldsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-record-logs\/{dataSourceRecordLogId}":{"get":{"tags":["data-source-record-logs"],"summary":"Find a data source record log by id","description":"Find a data source record log by id.<br>\n    Required permissions are: read access for data-source-record-logs.","operationId":"34be7ed8312305215873c01eef708b9e","parameters":[{"name":"dataSourceRecordLogId","in":"path","description":"The data source record log id.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"addresses"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-record-logs":{"get":{"tags":["data-source-record-logs"],"summary":"Find data-source-record-logs","description":"Find data source record logs.<br>\n    Required permissions are: read access for data source records.","operationId":"9f2fcb7255028995268ef4ab953b7a61","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific id.","required":false,"schema":{"type":"string"}},{"name":"filter[type]","in":"query","description":"Search for a specific type.","required":false,"schema":{"type":"string"}},{"name":"filter[dataSource]","in":"query","description":"Search for records for specific data source.","required":true,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"-time"},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"dataSource"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-sources\/{dataSourceId}\/records\/{recordId}":{"get":{"tags":["data-source-records [Beta]"],"summary":"Find data source record entries","operationId":"b5f25cee2a7bee48a22377b0e4cf1141","parameters":[{"name":"dataSourceId","in":"path","description":"The data source id.","required":true,"schema":{"type":"integer"}},{"name":"recordId","in":"path","description":"The record id.","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"put":{"tags":["data-source-records [Beta]"],"summary":"Update data source record entries","operationId":"75d62b95d80ad8c92c90795e8147c736","parameters":[{"name":"dataSourceId","in":"path","description":"The data source id.","required":true,"schema":{"type":"integer"}},{"name":"recordId","in":"path","description":"The record id.","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSourceRecordField"}}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-sources\/{dataSourceId}\/records\/bulk":{"put":{"tags":["data-source-records [Beta]"],"summary":"Insert or update multiple records for a data source.","description":"Insert or update multiple records for a data source. The save strategy is transactional (all or nothing).","operationId":"f38d28aabe04987a2bedd902e380ed4c","parameters":[{"name":"dataSourceId","in":"path","description":"The id of the data source.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceRecords\/Handler\/DataSourceRecordsPutBulkSchema.json"}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["data-source-records [Beta]"],"summary":"Delete data source records","description":"Deletes the given data source records.<br>\n    Required permissions are: write access for data-source-records.","operationId":"b3d3476bbb43d47c2592c7ca511a2f94","parameters":[{"name":"dataSourceId","in":"path","description":"The data source id.","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceRecords\/Handler\/DataSourceRecordsDeleteSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-tabs\/{dataSourceTabId}":{"get":{"tags":["data-source-tabs [Beta]"],"summary":"Find a data source tab by id","description":"Find a data source tab by id.<br>\n    Required permissions are: read access for data-source-tabs.","operationId":"6b0b044ae3a338c01efce7b23c976ecd","parameters":[{"name":"dataSourceTabId","in":"path","description":"The data source tab id.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"dataSource"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-source-tabs":{"get":{"tags":["data-source-tabs [Beta]"],"summary":"Find data-source-tabs","description":"Find data-source-tabs.<br>\n    Required permissions are: read access for data-source-tabs.","operationId":"a188b6da9f1efbc32cce433630d5b012","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[ids]","in":"query","description":"Search for data source tab ids (comma separated).","required":false,"schema":{"type":"string"}},{"name":"filter[labelDe]","in":"query","description":"Search for a specific german label. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[labelEn]","in":"query","description":"Search for a specific english label. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-labelDe"},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"dataSource"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["data-source-tabs [Beta]"],"summary":"Create a new data source tab","description":"Creates a new data source tab object and returns it.<br>\n    Required permissions are: write access for data-source-tabs.","operationId":"85c3ec49d1bfccca80bf8b3459b66007","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSourceTabs\/Handler\/DataSourceTabsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-sources\/{dataSourceId}":{"get":{"tags":["data-sources [Beta]"],"summary":"Find a data source by id","description":"Find a data source by id.<br>\n    Required permissions are: read access for data-sources.","operationId":"6dd70bd834461149c3631a05bac95303","parameters":[{"name":"dataSourceId","in":"path","description":"The data source id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/data-sources":{"get":{"tags":["data-sources [Beta]"],"summary":"Find data-sources","description":"Find data-sources.<br>\n    Required permissions are: read access for data-sources.","operationId":"084b003dad12f1880a64bfae3d0a2b8d","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[ids]","in":"query","description":"Search for data source ids (comma separated).","required":false,"schema":{"type":"string"}},{"name":"filter[name]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[tableName]","in":"query","description":"Search for a specific table name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[usage]","in":"query","description":"Search for a specific usage.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-name"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["data-sources [Beta]"],"summary":"Create a new data source","description":"Creates a new data source object and returns it.<br>\n    Required permissions are: write access for data-sources.","operationId":"2d28a564b8a89da7b77cfa7c676b9ae3","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/DataSources\/Handler\/DataSourcesPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/database-tables\/{databaseTable}\/columns":{"get":{"tags":["database-table-columns [Beta]"],"summary":"Find column names of database tables","description":"Find column names of certain system database tables & data sources.<br>\n    Required permissions are: read access for database-table-columns.","operationId":"622e1bf0451bd033c5415ed87a83d933","parameters":[{"name":"databaseTable","in":"path","description":"The database table name.","required":true,"schema":{"type":"string"}},{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/document-types\/{documentTypeId}":{"get":{"tags":["document-types"],"summary":"Find a document type by id","description":"Find a document type by id.","operationId":"a25fe2eb36b36bd9b44cd6781feccebf","parameters":[{"name":"documentTypeId","in":"path","description":"The document type id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/document-types":{"get":{"tags":["document-types"],"summary":"Find document-types","description":"Find document-types.","operationId":"a4ab7dfeba94ee06bc00ccf75fdba51d","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[ids]","in":"query","description":"Search for document type ids (comma separated).","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/documents\/{documentId}":{"get":{"tags":["documents"],"summary":"Find a document by id","description":"Find a document by id.","operationId":"eb8b4fc9694c3a1df78ac2b98e1867a2","parameters":[{"name":"documentId","in":"path","description":"The document id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/documents":{"get":{"tags":["documents"],"summary":"List documents by document type","description":"List documents by document type.","operationId":"b220092c915395a57a412a7cea9a12ba","parameters":[{"name":"filter[typeId]","in":"query","description":"The type id. <br><br> 1 = profile, <br> 2 = booking, <br> 3 = transcript, <br> 4 = invoice, <br> 5 = course,<br> 6 = lectureship,<br> 7 = exam, <br> 8 = submission internship, <br> 9 = subject version, <br> 10 = lecturer contract, <br> 11 = event date, <br> 12 = curriculum, <br> 13 = grading sheet, <br> 14 = cohort, <br> 15 = building, <br> 16 = course ticket","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"post":{"tags":["documents"],"summary":"Print a document","description":"Download a document. If no custom properties are given, the default values are used<br>\n    Required permissions are: write access for documents.","operationId":"31ed88919e3626bf62a245edb1f2a330","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Documents\/Handler\/DocumentsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/emails":{"post":{"tags":["emails"],"summary":"Sends an email to the given profiles. The delivery of the email can take up to several minutes.\n     *            Only general placeholders are replaced during delivery.","operationId":"7ec0f25a8d4a757d0f1b3651f8814255","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Email"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/events":{"get":{"tags":["events"],"summary":"List events [DEPRECATED use Event-series or Event-dates instead]","operationId":"d047771da2730be0f596c25eb3a918c0","parameters":[{"name":"startAt","in":"query","description":"Starting with element at position x. Default 0.","required":false,"schema":{"type":"integer","minimum":0}},{"name":"maxResults","in":"query","description":"Amount of elements. Value between 1 and 500. Default is 50.","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"startDate","in":"query","description":"Format: Y-m-d","required":false,"schema":{"type":"string"}},{"name":"endDate","in":"query","description":"Format: Y-m-d","required":false,"schema":{"type":"string"}},{"name":"siteIds[]","in":"query","description":"If none are given, the users sites will be used","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"customId","in":"query","description":"Custom Id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of events"}},"security":[{"basicAuth":[]}]},"post":{"tags":["events"],"summary":"Create a new event [DEPRECATED use Event-series or Event-dates instead]","operationId":"d81ac83cf1f5d5a058eedef516ffb878","parameters":[{"name":"customEventTypeId","in":"query","description":"Event type from settings -> Course management -> Event types","required":true,"schema":{"type":"integer","minimum":"1"}},{"name":"title","in":"query","description":"Only required if event type is based on singular event","required":false,"schema":{"type":"string"}},{"name":"date","in":"query","description":"Format: DD.MM.YYYY","required":true,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"Only required if all_day = 0, Format: HH:MM","required":false,"schema":{"type":"string"}},{"name":"endTime","in":"query","description":"Only required if all_day = 0, Format: HH:MM","required":false,"schema":{"type":"string"}},{"name":"all_day","in":"query","description":"0 = no, 1 = yes","required":true,"schema":{"type":"integer","maximum":"1","minimum":"0"}},{"name":"includeHolidays","in":"query","description":"0 = no, 1 = yes","required":true,"schema":{"type":"integer","maximum":"1","minimum":"0"}},{"name":"includeVacation","in":"query","description":"0 = no, 1 = yes","required":true,"schema":{"type":"integer","maximum":"1","minimum":"0"}},{"name":"includeWorkingPeriods","in":"query","description":"0 = no, 1 = yes","required":true,"schema":{"type":"integer","maximum":"1","minimum":"0"}},{"name":"recurrenceType","in":"query","description":"1 = Single, 2 = Weekly, 3 = Biweekly","required":true,"schema":{"type":"integer","minimum":"1"}},{"name":"courseId","in":"query","description":"Only required if recurrenceType != 1.","required":false,"schema":{"type":"integer","minimum":"1"}},{"name":"calculationChoice","in":"query","description":"Only required if recurrenceType != 1. Values: 1 = cancel after recurrenceCount, 2 = create events until endDate","required":false,"schema":{"type":"integer","maximum":"2","minimum":"1"}},{"name":"recurrenceCount","in":"query","description":"Only required if calculationChoice = 1 and recurrenceType != 1","required":false,"schema":{"type":"integer"}},{"name":"endDate","in":"query","description":"Only required if calculationChoice = 2 and recurrenceType != 1","required":false,"schema":{"type":"string"}},{"name":"siteId","in":"query","required":true,"schema":{"type":"integer","minimum":"1"}},{"name":"roomIds[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"planningStatus","in":"query","description":"Scheduler planning status id","required":true,"schema":{"type":"integer"}},{"name":"planningYear","in":"query","description":"Year for related courses and planning groups.","required":true,"schema":{"type":"integer"}},{"name":"planningTerm","in":"query","description":"1 = Winter, 2 = Summer","required":false,"schema":{"type":"integer"}},{"name":"comment","in":"query","required":false,"schema":{"type":"string"}},{"name":"comment2","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid input"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/events\/{eventDateId}":{"delete":{"tags":["events"],"summary":"Delete an event [DEPRECATED use Event-series or Event-dates instead]","operationId":"9648b99a632f83edcaf7b726950231b3","parameters":[{"name":"eventDateId","in":"path","description":"The event date id.","required":true,"schema":{"type":"integer","minimum":"1"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Invalid input"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["events"],"summary":"Update an event [DEPRECATED use Event-series or Event-dates instead]","description":"Updates an eventDate","operationId":"f064d2974c7fa66530100d2f40c9c91c","parameters":[{"name":"eventDateId","in":"path","description":"The event date id.","required":true,"schema":{"type":"integer","minimum":"1"}}],"requestBody":{"description":"Updates an event date","required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Event"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/event-series\/{eventSeriesId}\/event-dates\/{eventDateId}":{"get":{"tags":["event-dates"],"summary":"Find a event date by event date id","operationId":"7c32111a3036a7ba929f63b95adcac59","parameters":[{"name":"eventSeriesId","in":"path","description":"The event series id.","required":true,"schema":{"type":"string"}},{"name":"eventDateId","in":"path","description":"The event date id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["event-dates"],"summary":"Delete an eventDate","description":"Delete an event object.","operationId":"3cb0a271b0e791f5971b9529559620c8","parameters":[{"name":"eventSeriesId","in":"path","description":"The event series id.","required":true,"schema":{"type":"string"}},{"name":"eventDateId","in":"path","description":"The event id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["event-dates"],"summary":"Updates an eventDate.","description":"Updates an eventDate object and returns it.","operationId":"1c4c34672a4d97d816cd0f1a26e2e705","parameters":[{"name":"eventSeriesId","in":"path","description":"The event series id.","required":true,"schema":{"type":"integer","minimum":"1"}},{"name":"eventDateId","in":"path","description":"The event date id.","required":true,"schema":{"type":"integer","minimum":"1"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/EventSeries\/Handler\/EventDatePatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/event-series\/{eventSeriesId}\/event-dates":{"get":{"tags":["event-dates"],"summary":"Find all event dates by event series id","operationId":"57c98cb3925ab97d534406744d779166","parameters":[{"name":"eventSeriesId","in":"path","description":"The event series id.","required":true,"schema":{"type":"string"}},{"name":"customId","in":"query","description":"The custom id.","required":false,"schema":{"type":"string"}},{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"post":{"tags":["event-dates"],"summary":"Add a new eventDate to an eventSeries.","description":"Creates a new eventDate object and returns it. <br>Please note that the documentation of the EventDate schema cannot be\n     *     displayed correctly. <br>A 'title' or 'lectureSeriesPartId' and 'teachingUnits' must always be specified.<br>If 'allDay' is 'false',\n     *     'startTime' and 'endTime' are also required. ","operationId":"c052fb2c14e308c4d8f1b7635f1381ba","parameters":[{"name":"eventSeriesId","in":"path","description":"The event series id.","required":true,"schema":{"type":"integer","minimum":"1"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/EventSeries\/Handler\/EventDatePostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/event-series-custom":{"post":{"tags":["event-series"],"summary":"Create a custom EventSeries with eventDates","description":"Creates a new EventSeries object and returns it. Acepts the parameter for the EventSeries and the parameter for all the\n     *     EventDates","operationId":"f05f52deebd29e7809d38c3e4113b7c3","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/EventSeries\/Handler\/EventSeriesCustomPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["event-series"],"summary":"Update the EventDates of a EventSeries","description":"Adds, updates and deletes EventDates for a given EventSeries. Accepts the id for the EventSeries and the parameter for all the\n     *     EventDates","operationId":"2d1f93fe16fee662ebe7e1facbf96fc5","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/EventSeries\/Handler\/EventSeriesCustomPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/event-series\/{eventSeriesId}":{"get":{"tags":["event-series"],"summary":"Find eventseries","description":"example URL: \/api\/v1\/event-series\/1","operationId":"92a24a18ab09dee2af265ace79a5afd7","parameters":[{"name":"eventSeriesId","in":"path","description":"Please insert the eventSeriesId you want to search after.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["event-series"],"summary":"Delete an event series","description":"Delete an event series object and all events in this series.","operationId":"a7890a80c0f626fb180a82eca8177896","parameters":[{"name":"eventSeriesId","in":"path","description":"The event series id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/event-series":{"get":{"tags":["event-series"],"summary":"Find eventseries","description":"example URL: \/api\/v1\/event-series?page[size]=50&page[number]=1&filter[id]=1","operationId":"4aef4baf5b72e7ed6f3105bb6f7f7dc4","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"customId","in":"query","description":"The custom id.","required":false,"schema":{"type":"string"}},{"name":"courseId","in":"query","description":"The course id of the Series.","required":false,"schema":{"type":"string"}},{"name":"courseLectureSeriesId","in":"query","description":"The courseLectureSeries id of the Series.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["event-series"],"summary":"Creates a new eventseries.","description":"Creates a new eventseries object and returns it. <br>Please note that the documentation of the EventSeries schema cannot be\n     *     displayed correctly. <br>A 'title' or 'examId' or 'courseId' must always be specified. <br>Also, a 'calculationChoice' with 'endDate' or a\n     *     'calculationChoice\u2019  with 'recurrenceCount' must always be specified. <br>If 'allDay' is 'false', 'startTime' and 'endTime' are also\n     *     required. ","operationId":"c557d9443c9d5bf2d92894d66ab5494f","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/EventSeries\/Handler\/EventSeriesPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/cancellation\/id\/{cancellationId}":{"get":{"tags":["financial-documents"],"summary":"Download a cancellation document by id","description":"Download a cancellation document by id.<br>\n    Required permissions are: read access for financial payment.","operationId":"39fbcc8f2aa9fa868792ea722f15c0a6","parameters":[{"name":"cancellationId","in":"path","description":"The cancellation id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/cancellation\/number\/{cancellationNumber}":{"get":{"tags":["financial-documents"],"summary":"Download a cancellation document by number","description":"Download a cancellation document by number.<br>\n    Required permissions are: read access for financial payment.","operationId":"6a477db1d51a53628f45321caee4317a","parameters":[{"name":"cancellationNumber","in":"path","description":"The cancellation number.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/collection\/id\/{invoiceId}":{"get":{"tags":["financial-documents"],"summary":"Find a collection document by id","description":"Find a collection document by id.<br>\n    Required permissions are: read access for financial payment.","operationId":"9143ef76deee75d4d74139d139830325","parameters":[{"name":"invoiceId","in":"path","description":"The invoice id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/collection\/number\/{invoiceNumber}":{"get":{"tags":["financial-documents"],"summary":"Find a collection document by invoice number","description":"Find a collection document by invoice number.<br>\n    Required permissions are: read access for financial payment.","operationId":"e2c5fd29601cb00e626c1682136ce5d4","parameters":[{"name":"invoiceNumber","in":"path","description":"The invoice number.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/first-reminder\/id\/{invoiceId}":{"get":{"tags":["financial-documents"],"summary":"Find a first reminder document by id","description":"Find a first reminder document by id.<br>\n    Required permissions are: read access for financial payment.","operationId":"c73fc7e0f54cafcfbaa7b6219becf959","parameters":[{"name":"invoiceId","in":"path","description":"The invoice id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/first-reminder\/number\/{invoiceNumber}":{"get":{"tags":["financial-documents"],"summary":"Find a first reminder document by invoice number","description":"Find a first reminder document by invoice number.<br>\n    Required permissions are: read access for financial payment.","operationId":"46edf9f18c4eda303ff4de0710807a93","parameters":[{"name":"invoiceNumber","in":"path","description":"The invoice number.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/invoice\/id\/{invoiceId}":{"get":{"tags":["financial-documents"],"summary":"Find a invoice document by id","description":"Find a invoice document by id.<br>\n    Required permissions are: read access for financial payment.","operationId":"fe9f39d869cfb37fd92f53f58cf716c0","parameters":[{"name":"invoiceId","in":"path","description":"The invoice id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/invoice\/number\/{invoiceNumber}":{"get":{"tags":["financial-documents"],"summary":"Find a invoice document by invoice number","description":"Find a invoice document by invoice number.<br>\n    Required permissions are: read access for financial payment.","operationId":"e81db4bded74492883bf33e6aac41e8f","parameters":[{"name":"invoiceNumber","in":"path","description":"The invoice number.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/refund\/id\/{refundId}":{"get":{"tags":["financial-documents"],"summary":"Find a refund document by id","description":"Find a refund document by id.<br>\n    Required permissions are: read access for financial payment.","operationId":"f5660f2f61b2d02341218561df732fdf","parameters":[{"name":"refundId","in":"path","description":"The refund id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/refund\/number\/{refundNumber}":{"get":{"tags":["financial-documents"],"summary":"Find a refund document by refund number","description":"Find a refund document by refund number.<br>\n    Required permissions are: read access for financial payment.","operationId":"c7f50b5a421704cc8cfaf7c9327d9a4c","parameters":[{"name":"refundNumber","in":"path","description":"The refund number.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/second-reminder\/id\/{invoiceId}":{"get":{"tags":["financial-documents"],"summary":"Find a second reminder document by id","description":"Find a second reminder document by id.<br>\n    Required permissions are: read access for financial payment.","operationId":"e99597134fef47d4456bb515b1946c61","parameters":[{"name":"invoiceId","in":"path","description":"The invoice id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial-documents\/second-reminder\/number\/{invoiceNumber}":{"get":{"tags":["financial-documents"],"summary":"Find a second reminder document by invoice number","description":"Find a second reminder document by invoice number.<br>\n    Required permissions are: read access for financial payment.","operationId":"cda5c20492a4237196358cccdbc3ede2","parameters":[{"name":"invoiceNumber","in":"path","description":"The invoice number.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/gkv-pending-messages":{"get":{"tags":["gkv-pending-messages"],"summary":"Find gkv-pending-messages","description":"Find gkv-pending-messages.<br>Required permissions are: read access for gkv-pending-messages.","operationId":"3cd4f4005505f3341402130c44482950","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[ids]","in":"query","description":"Search for gkvpendingmessage ids (comma separated).","required":false,"schema":{"type":"string"}},{"name":"filter[messageType]","in":"query","description":"Search for one or more status as number (comma separated).","required":false,"schema":{"type":"string"}},{"name":"filter[message]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[healthInsuranceNumber]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[firstname]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[lastname]","in":"query","description":"Search for a specific name. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[assignedProfileId]","in":"query","description":"Search for an assigned profile id.","required":false,"schema":{"type":"integer"}},{"name":"filter[instituteString]","in":"query","description":"Search for a institute string. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id, receivedDate"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["gkv-pending-messages"],"summary":"Create a new gkv-pending-message","description":"Creates a new gkv-pending-message object and returns it.<br>\n    Required permissions are: write access for gkv-pending-message.<br>\n    If handled is set true, handled date must be set too.","operationId":"20e05b279e654b765779f410a6385ac6","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/GkvPendingMessages\/Handler\/GkvPendingMessagesPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["gkv-pending-messages"],"summary":"Update a gkv pending message","description":"Updates a gkv pending message and returns it.<br>\n    Required permissions are: write access for gkv-pending-messages.<br>\n    If handled is set true, handled date must be set too.","operationId":"f2cac13a0d631de1b8770d6e8391d9cb","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/GkvPendingMessages\/Handler\/GkvPendingMessagesPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/gkv-pending-messages\/batch":{"patch":{"tags":["gkv-pending-messages"],"summary":"Update gkv pending messages","description":"Updates gkv pending messages and returns them.<br>\n    Required permissions are: write access for gkv-pending-messages.<br>\n    If handled is set true, handled date must be set too.","operationId":"ad0900d65aeb5c605816cf335d7be37c","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/GkvPendingMessages\/Handler\/GkvPendingMessagesPatchBulkSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/gkv-pending-messages\/select-profile":{"patch":{"tags":["gkv-pending-messages"],"summary":"Select a profile for a gkv pending message","description":"Selects\/removes\/updates a profile of a gkv pending message, sets handled, handledDate and returns it.<br>\n    Required permissions are: write access for gkv-pending-messages.","operationId":"e5ea290015424f7e5eaed341dfb3e120","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/GkvPendingMessages\/Handler\/GkvPendingMessagesSelectProfileSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/global-file-syncs\/{globalFileSyncId}\/download":{"get":{"tags":["global-file-syncs [Beta]"],"summary":"Download a global file sync by id","description":"Download a global file sync by id.","operationId":"5e0843d1f38e7db691f295b42b8a59c3","parameters":[{"name":"globalFileSyncId","in":"path","description":"The global file sync id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/global-file-syncs\/{globalFileSyncId}":{"get":{"tags":["global-file-syncs [Beta]"],"summary":"Find a global file sync by id","description":"Find a global file sync by id.","operationId":"6e6470fc46caf34f0c340d12f9056139","parameters":[{"name":"globalFileSyncId","in":"path","description":"The global file sync id.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"documentType"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/global-file-syncs":{"get":{"tags":["global-file-syncs [Beta]"],"summary":"Find global-file-syncs","description":"Find global-file-syncs.<br>\n    Required permissions are: read access for global-file-syncs.","operationId":"415266ebcb5f3d00304239ea32855d1b","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific id.","required":false,"schema":{"type":"string"}},{"name":"filter[sourceArea]","in":"query","description":"Search for a specific sourceArea.","required":false,"schema":{"type":"string"},"example":"contact_history,infopool,digital_signature"},{"name":"filter[profileId]","in":"query","description":"Search for a specific profileId.","required":false,"schema":{"type":"string"},"example":"66"},{"name":"filter[bookingId]","in":"query","description":"Search for a specific bookingId.","required":false,"schema":{"type":"string"},"example":"904"},{"name":"filter[isTransferred]","in":"query","description":"Search for transfered files.","required":false,"schema":{"type":"string"},"example":"0,1"},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-createdAt,updatedAt,transferredAt,deletedAt"},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"documentType"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["global-file-syncs [Beta]"],"summary":"Update the global file sync","description":"Updates the global file sync and returns it.<br>\n    Required permissions are: write access for global file sync.","operationId":"730cef7c8a0517a831da4bda907b1592","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/GlobalFileSyncs\/Handler\/GlobalFileSyncsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/grade-annotations\/{gradeAnnotationId}":{"get":{"tags":["Grade-Annotations [Beta]"],"summary":"Find a grade annotation by id","operationId":"9fba9be1008a1b51dc9dd65dae70f680","parameters":[{"name":"gradeAnnotationId","in":"path","description":"The grade annotation id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["Grade-Annotations [Beta]"],"summary":"Deletes a grade annotation","description":"Deletes a grade annotation object.","operationId":"1fe6d574511a16c32b60e2375241d453","parameters":[{"name":"gradeAnnotationId","in":"path","description":"The grade annotation id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/grade-annotations":{"get":{"tags":["Grade-Annotations [Beta]"],"summary":"Find grade-annotations","operationId":"c29b2e0432fee797894369f361f69aaa","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific id.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"put":{"tags":["Grade-Annotations [Beta]"],"summary":"Update a grade annotation","description":"Updates a grade annotation and returns it.","operationId":"fb140f9ec9559369c42e48dbb5e2cf00","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/GradeAnnotation\/Handler\/GradeAnnotationPutSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["Grade-Annotations [Beta]"],"summary":"Create a new grade annotation","description":"Creates a new grade annotation object and returns it.","operationId":"13f0b7df51650d541e2fe86f73c0d720","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/GradeAnnotation\/Handler\/GradeAnnotationPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/grade-annotation-relations\/{gradeAnnotationRelationId}":{"get":{"tags":["grade-annotation-relations [Beta]"],"summary":"Find a grades annotation relation by id","operationId":"b03f7de061e6d50692e3db26118c828f","parameters":[{"name":"gradeAnnotationRelationId","in":"path","description":"The grades annotation relation id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["grade-annotation-relations [Beta]"],"summary":"Deletes a grades annotation relation","operationId":"b9907b7427d58c2c9e9b207aa4c64670","parameters":[{"name":"gradeAnnotationRelationId","in":"path","description":"The grades annotation relation id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/grade-annotation-relations":{"get":{"tags":["grade-annotation-relations [Beta]"],"summary":"Find grade-annotation-relations","operationId":"7d015c12c4e3e4893a4aedbedd8e7f57","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[grade]","in":"query","description":"Search for a specific gradeId (comma separated).","required":false,"schema":{"type":"string"},"example":"51,130"},{"name":"filter[gradeAnnotation]","in":"query","description":"Search for a specific gradeAnnotationId (comma separated).","required":false,"schema":{"type":"string"},"example":"1,3303"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["grade-annotation-relations [Beta]"],"summary":"Create a new grades annotation relation","description":"Creates a new grades annotation relation object and returns it.","operationId":"deae8eb620aec353fb1334b8ca6dea4f","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/GradeAnnotationRelations\/Handler\/GradeAnnotationRelationsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/grades\/{gradeId}":{"get":{"tags":["grades"],"summary":"Find grade by grade id.","description":"Find grades by grade id.<br> Required permissions are: read access for grades.","operationId":"6c9bc75f31f46eeb0ca518b26ce1a013","parameters":[{"name":"id","in":"query","description":"The grade id","required":false,"schema":{"type":"integer","example":1}},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"exam,gradeAnnotation,lecturers,moduleVersion,subjectVersion"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/Schema\/GradesGetSchema.json"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["grades"],"summary":"Deletes a grade","description":"Deletes a grade object.","operationId":"0bb34d95acc670174e951acf3739a974","parameters":[{"name":"gradeId","in":"path","description":"The grade id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/grades":{"post":{"tags":["grades"],"summary":"Create a new Grade.","description":"Creates a new Grade object and returns it.<br> Required permissions are: write access for Grades and Booking.","operationId":"c6a9e7622fe48328518e7759428a5614","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/Schema\/GradesPostSchema.json"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/Schema\/GradesGetSchema.json"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["grades"],"summary":"Update a Grade.","description":"Updates a new Grade and returns it.<br> Required permissions are: write access for Grades and Booking.","operationId":"c5a4bd18aa374f452e311139c8b45221","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/Schema\/GradesPatchSchema.json"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/Schema\/GradesGetSchema.json"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/grades\/module-grade-recalculation-jobs":{"get":{"tags":["grades"],"summary":"Find the current job for the module grade recalculation.","description":"Find the current job for the module grade recalculation.<br> Required permissions are: superuser","operationId":"27a8aca425e7d68e005feeffaba481c4","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/ModuleGradeRecalculation\/Schema\/ModuleGradeRecalculationJobsGetSchema.json"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"post":{"tags":["grades"],"summary":"Creates a new job to recalculate the module grades.","description":"Creates a new job to recalculate the module grades.<br> Required permissions are: superuser.","operationId":"848a4f3160a80ed62cb74c3276f63fb1","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/ModuleGradeRecalculation\/Schema\/ModuleGradeRecalculationJobsPostSchema.json"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/Schema\/GradesGetSchema.json"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Grades\/ModuleGradeRecalculation\/Schema\/ModuleGradeRecalculationJobsGetSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/health-insurance-institutes\/{identification}":{"get":{"tags":["health-insurance-institutes"],"summary":"Find a health insurance institute by identification","description":"Find a health insurance institute by identification.<br>\n    Required permissions are: read access for health-insurance-institutes.","operationId":"4f2bd5c70df7bd1c4368a3208eb893d2","parameters":[{"name":"identification","in":"path","description":"The health insurance institute identification.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["health-insurance-institutes"],"summary":"Deletes a health insurance institute","description":"Deletes a health insurance institute object.<br>\n    Required permissions are: write access for health-insurance-institutes.","operationId":"58f9ec816d9a099fa448f6287a2597e2","parameters":[{"name":"identification","in":"path","description":"The health insurance institute identification.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/health-insurance-institutes":{"get":{"tags":["health-insurance-institutes"],"summary":"Find health-insurance-institutes","description":"Find health-insurance-institutes.<br>\n    Required permissions are: read access for health-insurance-institutes.","operationId":"d598ca936450b6112ea4af8ced770844","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[identification]","in":"query","description":"Search for a specific identification.","required":false,"schema":{"type":"string"}},{"name":"filter[costUnit]","in":"query","description":"Search for a specific costUnit. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[costUnitName]","in":"query","description":"Search for a specific costUnitName. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[replacementNumber]","in":"query","description":"Search for a specific replacementNumber. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[davNumber]","in":"query","description":"Search for a specific davNumber. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"filter[validUntil]","in":"query","description":"Search for a specific validUntil. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"validUntil"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["health-insurance-institutes"],"summary":"Create a new health insurance institute","description":"Creates a new health insurance institute object and returns it.<br>\n    Required permissions are: write access for health-insurance-institutes.","operationId":"5280332018448a815b6da313a8fbaa91","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/HealthInsuranceInstitutes\/Handler\/HealthInsuranceInstitutesPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["health-insurance-institutes"],"summary":"Update a health insurance institute","description":"Updates a health insurance institute and returns it.<br>\n    Required permissions are: write access for health-insurance-institutes.","operationId":"ff95964fa6a3e687676ccebe568da574","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/HealthInsuranceInstitutes\/Handler\/HealthInsuranceInstitutesPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/health-insurance-profiles\/{healthInsuranceProfileId}":{"get":{"tags":["health-insurance-profiles [Beta]"],"summary":"Find a healthInsuranceProfile by profileId","operationId":"14e4acba6e37b0a26d00140d5f8887c7","parameters":[{"name":"healthInsuranceProfileId","in":"path","description":"The healthinsuranceprofile id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/health-insurance-profiles":{"get":{"tags":["health-insurance-profiles [Beta]"],"summary":"Find healthinsuranceprofiles","operationId":"fb80bd6f1fdc123f761ca0050e1447eb","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["health-insurance-profiles [Beta]"],"summary":"Add a health insurance profile","description":"Creates information for the profile of a student for the healthinsurance statistic","operationId":"a78b93b45e294f78d4680618ff0fa22f","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/HealthInsuranceProfile\/Handler\/HealthInsuranceProfilePostSchema.json"}}}},"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["health-insurance-profiles [Beta]"],"summary":"Update health insurace profile","description":"Updates information for the profile of a student for the healthinsurance statistic","operationId":"b528440b84f300f0867f25ee884184c4","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/HealthInsuranceProfile\/Handler\/HealthInsuranceProfilePatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/health-insurance-profile-communication-logs\/{id}":{"get":{"tags":["health-insurance-profile-communication-logs [Beta]"],"summary":"get a health insurance profile communication log for filter","operationId":"b608a67eedb53e760ef2d691e64b7853","parameters":[{"name":"id","in":"path","description":"The health-insurance-profile-communication-log Id.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/health-insurance-profile-communication-logs":{"get":{"tags":["health-insurance-profile-communication-logs [Beta]"],"summary":"Find Log Entries for health insurance communication","operationId":"12214c5b2a93db11f0942197a49cc523","parameters":[{"name":"filter[id]","in":"query","description":"The health insurance profile communication id.","required":true,"schema":{"type":"integer"}},{"name":"filter[status]","in":"query","description":"\n    1 = Outstanding |\n    2 = Delayed payment |\n    3 = Message sent(20 - start of studies) |\n    4 = Message sent(30 - end of studies) |\n    5 = Message incorrect(20 - start of studies) |\n    6 = Message incorrect(30 - end of studies) |\n    7 = Message incorrect |\n    8 = Message confirmed(20 - start of study) |\n    9 = Message confirmed(30 - end of studies) |\n    10 = Message confirmed\n    11 = Message canceled (20 - start of study)\n    12 = Message canceled (30 - end of study)\n    13 = Message canceled (insurance status)\n    14 = Message canceled (insurance change)\n    15 = Message canceled (payment default)\n    16 = Message canceled (payment default canceled)\n    60 = Correction requested\n    61 = Correction performed","required":true,"schema":{"type":"integer"}},{"name":"filter[profileId]","in":"query","description":"The profile Id.","required":true,"schema":{"type":"integer"}},{"name":"filter[requestId]","in":"query","description":"The Id of the request sent to the health insurance.","required":true,"schema":{"type":"string"}},{"name":"filter[responseId]","in":"query","description":"The Id from the answer of the health insurance.","required":true,"schema":{"type":"string"}},{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["health-insurance-profile-communication-logs [Beta]"],"summary":"Creates a new Health Insurance Log entry for the academy id and the status","description":"Status =\n    1 = Outstanding |\n    2 = Delayed payment |\n    3 = Message sent(20 - start of studies) |\n    4 = Message sent(30 - end of studies) |\n    5 = Message incorrect(20 - start of studies) |\n    6 = Message incorrect(30 - end of studies) |\n    7 = Message incorrect |\n    8 = Message confirmed(20 - start of study) |\n    9 = Message confirmed(30 - end of studies) |\n    10 = Message confirmed\n    11 = Message canceled (20 - start of study)\n    12 = Message canceled (30 - end of study)\n    13 = Message canceled (insurance status)\n    14 = Message canceled (insurance change)\n    15 = Message canceled (payment default)\n    16 = Message canceled (payment default canceled)\n    60 = Correction requested\n    61 = Correction performed","operationId":"b309fecca8c380b34ed7b3fda489ea4b","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/HealthInsuranceProfileCommunicationLog\/Handler\/HealthInsuranceProfileCommunicationLogPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["health-insurance-profile-communication-logs [Beta]"],"summary":"Updates a Health Insurance Log entry.","description":"Status =\n    1 = Outstanding |\n    2 = Delayed payment |\n    3 = Message sent(20 - start of studies) |\n    4 = Message sent(30 - end of studies) |\n    5 = Message incorrect(20 - start of studies) |\n    6 = Message incorrect(30 - end of studies) |\n    7 = Message incorrect |\n    8 = Message confirmed(20 - start of study) |\n    9 = Message confirmed(30 - end of studies) |\n    10 = Message confirmed\n    11 = Message canceled (20 - start of study)\n    12 = Message canceled (30 - end of study)\n    13 = Message canceled (insurance status)\n    14 = Message canceled (insurance change)\n    15 = Message canceled (payment default)\n    16 = Message canceled (payment default canceled)\n    60 = Correction requested\n    61 = Correction performed","operationId":"4a7b2f859c0955b29e2eaa1b041e7026","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/HealthInsuranceProfileCommunicationLog\/Handler\/HealthInsuranceProfileCommunicationLogPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/health-insurance-reporting-institutes\/{healthInsuranceReportingInstituteId}":{"get":{"tags":["health-insurance-reporting-institutes [Beta]"],"summary":"Find a healthInsuranceReportingInstitute by id","operationId":"f42d068cbb190ce58b2c14e0a7454d50","parameters":[{"name":"healthInsuranceReportingInstituteId","in":"path","description":"The healthInsuranceReportingInstitute id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/health-insurance-reporting-institutes":{"get":{"tags":["health-insurance-reporting-institutes [Beta]"],"summary":"Find healthInsuranceReportingInstitutes","operationId":"29f9cb704bd08f0ddd4f38670cb42f97","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[siteId]","in":"query","description":"Search for a specific siteId.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/icons":{"get":{"tags":["icons [Beta]"],"summary":"Find icons that are assignable to resources.","description":"Find icons that are assignable to resources.","operationId":"7ebf6f59b86f7191f60b20f9ac910281","responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Icons\/Schema\/IconsListGetSchema.json"}}}}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial\/installments\/{installmentId}\/invoice-collections":{"post":{"tags":["invoiceCollections"],"summary":"Create a new collection of invoices from an installment.","description":"Creates a new invoice collection object and returns it.<br>\n    Required permissions are: write access for invoices.","operationId":"fde4874ca9304845532c2438e9e77a05","parameters":[{"name":"installmentId","in":"path","description":"The installment id.","required":true,"schema":{"type":"integer","minimum":"1"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/InvoiceCollections\/Handler\/InvoiceCollectionsFromInstallmentsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/invoice-queue-entries\/generate-from-payment-model":{"post":{"tags":["invoice-queue-entries"],"summary":"Creates invoice queue entries","description":"Creates the installments and invoices (in status open) for the given payment model (applicant) and booking (applicant).<br> Required permissions are: write access for invoices.","operationId":"2d7f8e7ddd36246d1165783e002ba38f","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/InvoiceQueueEntries\/Handler\/InvoiceQueueEntriesPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial\/invoices":{"post":{"tags":["invoices"],"summary":"Create a new invoice","description":"Creates a new invoice object and returns it.<br>\n    Required permissions are: write access for invoices.","operationId":"a2bf3de398320ab8c6df76ad1081d3b2","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Invoices\/Handler\/InvoicesPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/financial\/invoices\/status-change":{"post":{"tags":["invoices"],"summary":"Changes the status of invoices","description":"Creates system background jobs that change the status of invoices from draft to open.<br>\n    Required permissions are: write access for invoices.","operationId":"e285e15e64953be2a00f0d0ebf620540","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Invoices\/Handler\/InvoicesStatusChangePostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/lecturer-contract-employment-availabilities\/{lecturerContractEmploymentAvailabilityId}":{"get":{"tags":["lecturer-contract-employment-availabilities"],"summary":"Find a lecturer contract employment availability by id","description":"Find a lecturer contract employment availability by id.<br>\n    Required permissions are: manage access for lecturer-contracts.","operationId":"ec69ba7280363cd631fbc7caa50ef9ee","parameters":[{"name":"lecturerContractEmploymentAvailabilityId","in":"path","description":"The lecturer contract employment availability id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["lecturer-contract-employment-availabilities"],"summary":"Deletes a lecturer contract employment availability","description":"Deletes a lecturer contract employment availability object.<br>\n    Required permissions are: manage access for lecturer-contracts.","operationId":"d5768f8870cd7bbab0ad53ca4e0ad381","parameters":[{"name":"lecturerContractEmploymentAvailabilityId","in":"path","description":"The lecturer contract employment availability id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/lecturer-contract-employment-availabilities":{"get":{"tags":["lecturer-contract-employment-availabilities"],"summary":"Find lecturer-contract-employment-availabilities","description":"Find lecturer-contract-employment-availabilities.<br>\n    Required permissions are: manage access for lecturer-contracts.","operationId":"d17eadfba4d09004b5abcc74763e70ee","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[ids]","in":"query","description":"Search for lecturer contract employment availability ids (comma separated).","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id"},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"lecturer-contracts"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["lecturer-contract-employment-availabilities"],"summary":"Create a new lecturer contract employment availability","description":"Creates a new lecturer contract employment availability object and returns it.<br>\n    Required permissions are: manage access for lecturer-contracts.","operationId":"92d868e8ab4bfcdb7d1999013aaa4304","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/LecturerContractEmploymentAvailabilities\/Handler\/LecturerContractEmploymentAvailabilitiesPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["lecturer-contract-employment-availabilities"],"summary":"Update a lecturer contract employment availability","description":"Updates a lecturer contract employment availability and returns it.<br>\n    Required permissions are: manage access for lecturer-contracts.","operationId":"cae3c908c7125d15f06b45c589999100","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/LecturerContractEmploymentAvailabilities\/Handler\/LecturerContractEmploymentAvailabilitiesPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/lecturer-contract-employments\/{lecturerContractEmploymentId}":{"get":{"tags":["lecturer-contract-employments [Beta]"],"summary":"Find a lecturer contract employment by id","description":"Find a lecturer contract employment by id.<br>\n    Required permissions are: read access for lecturer contracts and read access for lecturers and authors.","operationId":"6e21ba780e95d32321318d5e366577ce","parameters":[{"name":"lecturerContractEmploymentId","in":"path","description":"The lecturer contract employment id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["lecturer-contract-employments [Beta]"],"summary":"Deletes a lecturer contract employment","description":"Deletes a lecturer contract employment object.<br>\n    Required permissions are: write access for lecturer contracts and write access for lecturers and authors.","operationId":"022bd0afec91f22695e6633afbaa5f39","parameters":[{"name":"lecturerContractEmploymentId","in":"path","description":"The lecturer contract employment id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/lecturer-contract-employments":{"get":{"tags":["lecturer-contract-employments [Beta]"],"summary":"Find lecturer contract employments","description":"Find lecturer contract employments.<br>\n    Required permissions are: read access for lecturer contracts and read access for lecturers and authors.","operationId":"7b2373e17ede8382287a5e8abebf517f","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific id.","required":false,"schema":{"type":"string"}},{"name":"filter[startDate]","in":"query","description":"Search entries greater than or equal to startDate. Format: YYYY-MM-DD","required":false,"schema":{"type":"string"},"example":"2020-01-01"},{"name":"filter[endDate]","in":"query","description":"Search entries less than or equal to endDate. Format: YYYY-MM-DD","required":false,"schema":{"type":"string"},"example":"2030-01-01"},{"name":"filter[lecturerContractId]","in":"query","description":"Search for a specific lecturer contract id.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending. Sortable fields are: id, startDate, endDate.","required":false,"schema":{"type":"string"},"example":"id"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["lecturer-contract-employments [Beta]"],"summary":"Create a new lecturer contract employment","description":"Creates a new lecturer contract employment object and returns it.<br>\n    Required permissions are: write access for lecturer contracts and write access for lecturers and authors.","operationId":"d3e562aab65153c7a1aaea72ab40dadf","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/LecturerContractEmployments\/Handler\/LecturerContractEmploymentsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["lecturer-contract-employments [Beta]"],"summary":"Update a lecturer contract employment","description":"Updates a lecturer contract employment and returns it.<br>\n    Required permissions are: write access for lecturer contracts and write access for lecturers and authors.","operationId":"1f2765772d367afeaa2efcc0da7b59c8","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/LecturerContractEmployments\/Handler\/LecturerContractEmploymentsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/lecturer-contracts\/{lecturerContractId}":{"get":{"tags":["lecturer-contracts [Beta]"],"summary":"Find a lecturer contract by id.","operationId":"0daf1d61669bb47d0b453a04426a35ce","parameters":[{"name":"lecturerContractId","in":"path","description":"The lecturer contract id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/lecturer-contracts":{"get":{"tags":["lecturer-contracts [Beta]"],"summary":"Find lecturer contracts.","operationId":"7cca80ef988ce5f53168e777a06a7a5d","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[id]","in":"query","description":"Search for a specific id.","required":false,"schema":{"type":"string"}},{"name":"filter[profileId]","in":"query","description":"Filter contracts for a specific profile id","required":false,"schema":{"type":"string"}},{"name":"filter[siteId]","in":"query","description":"Filter contracts for a site id","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-profileId"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["lecturer-contracts [Beta]"],"summary":"Create a new lecturer contract","description":"Creates a new lecturer conctract object and returns it.","operationId":"edf9486c862c0d75abb56f2b1a2f53dc","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/LecturerContracts\/Handler\/LecturerContractsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["lecturer-contracts [Beta]"],"summary":"Update a lecturer contract","description":"Updates a lecturer contract and returns it.","operationId":"73ee6f0c308d435de9872685b1b9abed","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/LecturerContracts\/Handler\/LecturerContractsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/maintenance\/cache-information":{"get":{"tags":["Maintenance [Dev-Only]"],"summary":"provides information about cache","description":"provides information about cache<br>Required permissions are: Administrator","operationId":"60828614054fdf91a3d1507d94a3f4f3","responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/maintenance\/clear-cache":{"get":{"tags":["Maintenance [Dev-Only]"],"summary":"Clear cache","description":"Clear cache<br>Required permissions are: read access for Maintenance.","operationId":"dee88dd2a856057db38169775b58bd39","responses":{"204":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/maintenance\/session-information":{"get":{"tags":["Maintenance [Dev-Only]"],"summary":"provides information about the session","description":"provides information about session<br>Required permissions are: administrator","operationId":"d8edcb01099403ea0b4bf26144ab1e9a","responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/navigation\/areas":{"get":{"tags":["navigation [Dev-Only]"],"summary":"Get the navigation areas for the current user","description":"Get the navigation areas for the current user","operationId":"d558a019221ad89dfc282e29c7d879d2","responses":{"200":{"description":"Success"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/navigation\/hubs\/{areaId}":{"get":{"tags":["navigation [Dev-Only]"],"summary":"Get the navigation hubs for the current navigation area","description":"Get the navigation hubs for the current navigation area","operationId":"b2d295b7f52d444c1ed3c1c9750779e9","parameters":[{"name":"areaId","in":"path","description":"The parent navigation item id","required":true,"schema":{"type":"string","enum":["applications","archiving","cooperation","course-management","exam-management","finance-management","info-consulting","my-academyfive","prospectives","reporting","student-management","submission-management","teaching"]}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/navigation\/sub-hubs\/campus-web-domain\/{domainId}":{"get":{"tags":["navigation [Dev-Only]"],"summary":"Get the navigation sub hub for a campus web domain","description":"Get the navigation sub hub for a campus web domain","operationId":"f6d8ff72a4c660574884d8c8bd596c66","parameters":[{"name":"domainId","in":"path","description":"The domain id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/notification-banners\/{notificationBannerId}":{"get":{"tags":["notification-banners [Dev-Only]"],"summary":"Find a notification banner by id.","description":"Find a notification banner by id","operationId":"b0f10fdf580636b2f5bf62f2e8f84e70","parameters":[{"name":"notificationBannerId","in":"path","description":"The notification banner id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/NotificationBanners"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/notification-banners":{"get":{"tags":["notification-banners [Dev-Only]"],"summary":"Find notification-banners","description":"Find notification-banners","operationId":"834d40af1389adbb85b9e82b586d86bc","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer","example":50}},{"name":"filter[isActive]","in":"query","description":"Filter by active status.","required":false,"schema":{"type":"int","example":"1"}},{"name":"filter[colorType]","in":"query","description":"Filter by type.","required":false,"schema":{"type":"integer","example":"1"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id, isActive, colorType"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/NotificationBanners"}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/online-exam-enrolments\/{onlineExamEnrolmentId}":{"get":{"tags":["online-exam-enrolments"],"summary":"Find an online exam enrolment by id","description":"Find an online exam enrolment by id.<br>\n    Required permissions are: write access for online-exam-enrolments.","operationId":"1948ac98ffb7e51e6e514a0ab55bfcf2","parameters":[{"name":"onlineExamEnrolmentId","in":"path","description":"The online exam enrolment id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["online-exam-enrolments"],"summary":"Deletes an online exam enrolment","description":"Deletes an online exam enrolment object.<br>\n    Required permissions are: write access for online-exam-enrolments.","operationId":"009ac7778784c98fe2fb1c0d3183ec89","parameters":[{"name":"onlineExamEnrolmentId","in":"path","description":"The online exam enrolment id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/online-exam-enrolments":{"post":{"tags":["online-exam-enrolments"],"summary":"Creates an new online exam enrolment","description":"Creates an new online exam enrolment object and returns it.<br>\n    Required permissions are: write access for online-exam-enrolments.","operationId":"5bd238d50c0be484190c3d4daa0a7dfb","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/OnlineExamEnrolments\/Handler\/OnlineExamEnrolmentsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/payments":{"post":{"tags":["payments"],"summary":"Adds Payments for invoices","description":"Adds Payments for invoices returns the added entries","operationId":"cf62acabf302a3e02433d60f70f153cc","requestBody":{"description":"Client side payments","required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Payment\/Command\/PaymentAddCommandSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/payment-model-previews\/{paymentModelId}":{"get":{"tags":["PaymentModelPreviews"],"summary":"Find an applicant payment model preview by specifying the payment-model-id","description":"This route is only for payment-models of the type \u201cApplicant\u201d.\n    This route can be used to get back information on what the applicants has to pay for their application.<br>\n    Required permissions are: read access for paymentModel.","operationId":"00c8162ccab1feae3dd986b58aaba1b4","parameters":[{"name":"paymentModelId","in":"path","description":"The paymentModel id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/professional-backgrounds\/{professionalBackgroundId}":{"get":{"tags":["Professional-Backgrounds [Beta]"],"summary":"Find a professional background by id","operationId":"c21466a8e474d3c1d1d4368880586a9d","parameters":[{"name":"professionalBackgroundId","in":"path","description":"The professional background id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["Professional-Backgrounds [Beta]"],"summary":"Deletes a professional background","description":"Deletes a professional background.","operationId":"0cf1d01a84b2e5952a145e37a518c9f5","parameters":[{"name":"professionalBackgroundId","in":"path","description":"The professional background id.","required":true,"schema":{"type":"string"}}],"responses":{"203":{"description":"Success No Content"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/professional-backgrounds":{"get":{"tags":["Professional-Backgrounds [Beta]"],"summary":"Find professional backgrounds","operationId":"a8cfa494860e4cd1c93c6aa07d0e5b08","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[profileId]","in":"query","description":"Search for a specific profileId.","required":false,"schema":{"type":"string"}},{"name":"filter[companyId]","in":"query","description":"Search for a specific companyId","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"put":{"tags":["Professional-Backgrounds [Beta]"],"summary":"Update a professional background","description":"Updates a professional background and returns it.","operationId":"ee0da8e891a2c5afcd1242aed4d3801e","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/ProfessionalBackground\/Handler\/ProfessionalBackgroundPutSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["Professional-Backgrounds [Beta]"],"summary":"Create a new professional background","description":"Creates a new professional background object and returns it.","operationId":"54bb8f9799a1b8b49bf309c833f395a3","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/ProfessionalBackground\/Handler\/ProfessionalBackgroundPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/profile-bank-details\/{profileId}":{"get":{"tags":["profile-bank-details [Dev-Only]"],"summary":"Find a profile bank detail by profileId","description":"Find a profile bank detail by profileId.<br>\n    Required permissions are: RIGHT_FINANCIAL_BANK_DATA_READ.","operationId":"d829408ae37460206f75bcb02a544b3a","parameters":[{"name":"profileId","in":"path","description":"The profileId.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["profile-bank-details [Dev-Only]"],"summary":"Deletes a profile bank detail by profileId","description":"Deletes a profile bank detail object.<br>\n    Required permissions are: RIGHT_FINANCIAL_BANK_DATA_WRITE.","operationId":"bb5d65faeb368c7aefbd85c7681380cd","parameters":[{"name":"profileId","in":"path","description":"The profileId.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/profile-bank-details":{"post":{"tags":["profile-bank-details [Dev-Only]"],"summary":"Create a new profile bank detail","description":"Creates a new profile bank detail object and returns it.<br>\n    Required permissions are: RIGHT_FINANCIAL_BANK_DATA_WRITE.","operationId":"d09c3d4d81e261a224db73c962c0a9eb","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/ProfileBankDetails\/Handler\/ProfileBankDetailsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["profile-bank-details [Dev-Only]"],"summary":"Update a new profile bank detail","description":"Updates a new profile bank detail object and returns it.<br>\n    Required permissions are: RIGHT_FINANCIAL_BANK_DATA_WRITE.","operationId":"33bb08485d790d6a1582fc7b45ab87aa","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/ProfileBankDetails\/Handler\/ProfileBankDetailsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/profiles\/{profileId}\/avatar":{"get":{"tags":["profiles [Beta]"],"summary":"Find profile avatar by profile id.","description":"Find profile avatar by profile id.","operationId":"a8dcebe5a71c759f678ee4c6401463e4","parameters":[{"name":"profileId","in":"path","description":"The profile id","required":false,"schema":{"type":"integer","example":20}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/profiles\/{profilesId}":{"delete":{"tags":["profiles [Beta]"],"summary":"Deletes a profile","description":"Deletes a profile object.<br>\n    Required permissions are: group-specific delete access for profiles, at least one matching site, delete access for bookings if user has bookings, profile must not be admin or simadmin profile.","operationId":"4458bc5a5c18e01ded12650d58496739","parameters":[{"name":"profilesId","in":"path","description":"The profile id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/profiles":{"patch":{"tags":["profiles [Beta]"],"summary":"Update a Profiles.","description":"Updates a profile and returns it.<br> Required permissions are: write access for the profile depending on its status (prospective\/applicant\/student\/lecturer\/author\/other.","operationId":"1d0c64193eb5283219bc8606e9dda07b","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Profiles\/Handler\/ProfilesPatchSchema.json"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Profiles\/Schema\/ProfilesGetSchema.json"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/profit-centers":{"post":{"tags":["profit-centers"],"summary":"Creates new profit center entry","description":"Creates new profit center entries and returns the created profit center entries","operationId":"bd305b282332bef010bf4faa4a73f7f7","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProfitCenterAdd"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/request-form-profile-comments":{"post":{"tags":["request-form-profile-comments"],"summary":"Creates a request form profile comment object.","description":"Creates a request form profile comment. Handles sending of E-Mail, logs the request in request_form_log.<br \/>Required permissions are: RIGHT_REQUEST_FORM_WRITE.","operationId":"b545200eb59014876f8c0abf61753b45","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/RequestFormProfileComments\/Schema\/RequestFormProfileCommentsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/request-form-profiles\/{requestFormProfileId}":{"delete":{"tags":["request-form-profiles"],"summary":"Deletes a request form profile object.","description":"Deletes a request form profile. Logs the request in request_form_log.<br \/>Required permissions are: RIGHT_REQUEST_FORM_WRITE.","operationId":"cf76732f79b7d8ff78c2ced8628d52ac","parameters":[{"name":"requestFormProfileId","in":"path","description":"The request_form_profile id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/request-form-profiles":{"patch":{"tags":["request-form-profiles"],"summary":"Updates a request form profile object.","description":"Updates a request form profile. Logs the request in request_form_log.<br \/>Required permissions are: RIGHT_REQUEST_FORM_WRITE.","operationId":"7f6e230e49d18252c2d6766d5a514a9e","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/RequestFormProfiles\/Schema\/RequestFromProfilesPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/revenue-accounts\/{revenueAccountId}":{"get":{"tags":["revenue-accounts"],"summary":"Find a revenue account by id","description":"Find a revenue account by id.<br>\n    Required permissions are: RIGHT_FINANCIAL_SETTINGS","operationId":"8a4ade7c118d723c4d3db40ae73b439c","parameters":[{"name":"revenueAccountId","in":"path","description":"The revenue account id.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"sites"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["revenue-accounts"],"summary":"Deletes a revenue account","description":"Deletes a revenue account object.<br>\n    Required permissions are: RIGHT_FINANCIAL_SETTINGS","operationId":"6e639f6b36249176c8162cd7d5863ed4","parameters":[{"name":"revenueAccountId","in":"path","description":"The revenue account id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/revenue-accounts":{"get":{"tags":["revenue-accounts [Dev-Only]"],"summary":"Find revenue-accounts","description":"Find revenue-accounts.<br>\n    Required permissions are: RIGHT_FINANCIAL_SETTINGS","operationId":"bfe485b6336b9f3c7981c9dca856ce44","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"filter[ids]","in":"query","description":"Search for revenue account ids (comma separated).","required":false,"schema":{"type":"string"}},{"name":"filter[revenueAccountNumber]","in":"query","description":"Search for a specific account number. Use % as wildcard.","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"id,-revenueAccountNumber"},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"sites"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["revenue-accounts"],"summary":"Create a new revenue account","description":"Creates a new revenue account object and returns it.<br>\n    Required permissions are: RIGHT_FINANCIAL_SETTINGS","operationId":"e07433ee5bb6458868e47a569e3bc213","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/RevenueAccounts\/Handler\/RevenueAccountsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["revenue-accounts"],"summary":"Update a revenue account","description":"Updates a revenue account and returns it.<br>\n    Required permissions are: RIGHT_FINANCIAL_SETTINGS","operationId":"685f401a2be761f943b8bdd5247c038f","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/RevenueAccounts\/Handler\/RevenueAccountsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/profiles\/{profileId}\/statistic-austria":{"get":{"tags":["statistic-austria  [Dev-Only]"],"summary":"Find the statistic austria by profile id.","description":"Find the statistic austria by profile id.<br>\n    Required permissions are: read access for statistic-austria.","operationId":"486cfde7c02fbb15e2c11aecfc669dce","parameters":[{"name":"profileId","in":"path","description":"The profile id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"post":{"tags":["statistic-austria  [Dev-Only]"],"summary":"Create a new statistic austria","description":"Creates a new statistic austria object and returns it.<br>\n    Required permissions are: write access for statistic-austria.","operationId":"a55336b71d405b69ffad41ede21e57bb","parameters":[{"name":"profileId","in":"path","description":"The profile id.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/StatisticAustria\/Handler\/StatisticAustriaPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["statistic-austria  [Dev-Only]"],"summary":"Update a statistic austria","description":"Updates a statistic austria and returns it.<br>\n    Required permissions are: write access for statistic-austria.","operationId":"8403d9bfdce43dc47d0881a906f64c43","parameters":[{"name":"profileId","in":"path","description":"The profile id.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/StatisticAustria\/Handler\/StatisticAustriaPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/statistic-austria\/profiles-missing-UHStat1":{"get":{"tags":["statistic-austria  [Dev-Only]"],"summary":"Find profile ids with missing UHStat1 field by booking status.","description":"Find profile ids with missing UHStat1 field by booking status.<br>\n    Required permissions are: read access for statistic-austria.","operationId":"a14649fcd917c41281589b918d0b6a0b","parameters":[{"name":"filter[bookingStatus]","in":"query","description":"The booking status id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/statistic-validations":{"post":{"tags":["statistic-validations [Dev-Only]"],"summary":"Perform a statistic validation","description":"Perform a statistic validation on a profile and return validation error.<br>\n    Required permissions are: write access for german statistic.","operationId":"bf1ba6e3107faae7b273f726b911a1d6","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/StatisticValidations\/Handler\/StatisticValidationsPostSchema.json"}}}},"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/student-profiles":{"get":{"tags":["student-profiles [Beta]"],"summary":"Find student profiles","description":"Find student profiles.<br> Required permissions are: read access for student profiles.","operationId":"4e44170984cd81c7bbdef8ee0db32440","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer","example":50}},{"name":"filter[name]","in":"query","description":"Search for a specific name.","required":false,"schema":{"type":"string","example":"John"}},{"name":"filter[cohortIds]","in":"query","description":"Search for student profiles with specific cohortIds.","required":false,"schema":{"type":"string","example":"40,23,230"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string","example":"ids,-firstName,lastName"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Cohorts\/Schema\/CohortsGetPaginatedSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/subject-versions\/{subjectVersionId}":{"delete":{"tags":["subjectVersion"],"summary":"Deletes a subjectVersion","description":"Deletes a subjectVersion object.\n            A subjectVersion cannot be deleted if\n            - there is no other subjectVersion for the subject\n            - it is in use in a course offering, module, curriculum or exam\n            Required permissions are: \"Delete categories, subject versions and module versions\"\n        ","operationId":"89062672909716fceca25d893864db4d","parameters":[{"name":"subjectVersionId","in":"path","description":"The subjectVersion id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/submissions\/{id}\/status-change":{"post":{"tags":["submissions"],"summary":"Change the status of a submission","description":"Change the status of a submission.","operationId":"74699d3c57f8aa6a2499ac24bb4363c3","parameters":[{"name":"id","in":"path","description":"The id of the submission.","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Submissions\/StatusChange\/Handler\/SubmissionsStatusChangePostSchema.json"}}}},"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/task-types\/{taskTypeId}":{"get":{"tags":["task-types [Beta]"],"summary":"Find a task type by id","description":"Find a task type by id.<br> Required permissions are: read access for task-types.","operationId":"1cf554d87a82cd7f6c22f8db644f91be","parameters":[{"name":"taskTypeId","in":"path","description":"The task type id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/TaskTypes\/Schema\/TaskTypesGetSchema.json"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["task-types [Beta]"],"summary":"Deletes a task type","description":"Deletes a task type object.<br>Required permissions are: write access for task-types.","operationId":"5b5d20cc30e0ddb5bc00d4332a96ce3a","parameters":[{"name":"taskTypeId","in":"path","description":"The task type id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/task-types":{"get":{"tags":["task-types [Beta]"],"summary":"Find task-types","description":"Find task-types.<br> Required permissions are: read access for task-types.","operationId":"a7441cfd7b0b96aaa70862b7d41deeb3","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer","example":1}},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer","example":50}},{"name":"filter[ids]","in":"query","description":"Search for a specific ids.","required":false,"schema":{"type":"string","example":"01JSPG1XWZKRR3MC4HVB2DW72D,01JSPG1XX00SSXECV9HEQ4Q42T,01JSPG1XX1GPQ6FHXJTYPGVR2M"}},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string","example":"ids"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/TaskTypes\/Schema\/TaskTypesGetSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["task-types [Beta]"],"summary":"Create a new task type","description":"Create a new task type.<br>Required permissions are: write access for task-types.","operationId":"622e226f8666eae9f65ec1b81563d4fc","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/TaskTypes\/Schema\/TaskTypesPostSchema.json"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/TaskTypes\/Schema\/TaskTypesGetSchema.json"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["task-types [Beta]"],"summary":"Create a new task type","description":"Update a new task type.<br>Required permissions are: write access for task-types.","operationId":"a60fb4bc91638d46cec0313274a2aa29","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/TaskTypes\/Schema\/TaskTypesPatchSchema.json"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/TaskTypes\/Schema\/TaskTypesGetSchema.json"}}}},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/translation-placeholders":{"get":{"tags":["translation-placeholders [Dev-Only]"],"summary":"Find translation placeholders.","description":"Find translation placeholders.","operationId":"2200ddd94afc0ab622d8ee3cfcd9b670","parameters":[{"name":"filter[languageKeys]","in":"query","description":"Search for specific language keys.","required":true,"schema":{"type":"string"},"example":"de,en"}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/TranslationPlaceholders\/Schema\/TranslationPlaceholdersGetSchema.json"}}}}}}},"\/api\/v1\/zensus-settings\/{zensusSettingId}":{"get":{"tags":["zensus-settings [Dev-Only]"],"summary":"Find a zensus setting by id","description":"Find a zensus setting by id.<br>\n    Required permissions are: read access for zensus-settings.","operationId":"d05372b330a8216e55005237b9e268c0","parameters":[{"name":"zensusSettingId","in":"path","description":"The zensus setting id.","required":true,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":true,"schema":{"type":"string"},"example":"siteIds"}],"responses":{"200":{"description":"Success"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"basicAuth":[]}]},"delete":{"tags":["zensus-settings [Dev-Only]"],"summary":"Deletes a zensus setting","description":"Deletes a zensus setting object.<br>\n    Required permissions are: write access for zensus-settings.","operationId":"631e4f9ea55253c04ee68a64546d4e3b","parameters":[{"name":"zensusSettingId","in":"path","description":"The zensus setting id.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success No Content"},"400":{"description":"Bad Request","content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/Common\/Model\/Validation\/ValidationErrorSchema.json"}}}},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}},"\/api\/v1\/zensus-settings":{"get":{"tags":["zensus-settings [Dev-Only]"],"summary":"Find zensus-settings","description":"Find zensus-settings.<br>\n    Required permissions are: access to zensus-settings.","operationId":"3931937ed3c72eff6696c727bc71b294","parameters":[{"name":"page[number]","in":"query","description":"The page number, default 1.","required":false,"schema":{"type":"integer"},"example":"1"},{"name":"page[size]","in":"query","description":"The page size, default 50.","required":false,"schema":{"type":"integer"},"example":"50"},{"name":"sort","in":"query","description":"Comma seperated sort fields. Default ascending, minus before field for descending.","required":false,"schema":{"type":"string"},"example":"webUrl"},{"name":"include","in":"query","description":"Comma seperated included relationships. Default none.","required":false,"schema":{"type":"string"},"example":"sites"}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"post":{"tags":["zensus-settings [Dev-Only]"],"summary":"Create a new zensus setting","description":"Creates a new zensus setting object and returns it.<br>\n    Required permissions are: write access for zensus-settings.","operationId":"cd0e7baeed9975cb6edf47ac6f940642","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/ZensusSettings\/Handler\/ZensusSettingsPostSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]},"patch":{"tags":["zensus-settings [Dev-Only]"],"summary":"Update a zensus setting","description":"Updates a zensus setting and returns it.<br>\n    Required permissions are: write access for zensus-settings.","operationId":"f743a2d61107e238837580e493d7144e","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"\/src\/Api\/ZensusSettings\/Handler\/ZensusSettingsPatchSchema.json"}}}},"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}},"security":[{"basicAuth":[]}]}}},"components":{"schemas":{"BookingStatisticAustria":{"title":"BookingStatisticAustria"},"Company":{"title":"Company","properties":{"id":{"description":"The id of the company.","type":"string","nullable":true},"name":{"description":"The name of the company.","type":"string","nullable":true},"nameSuffix":{"description":"The additional name of the company.","type":"string","nullable":true},"additionalAddress":{"description":"The additional address of the company.","type":"string","nullable":true},"active":{"type":"boolean"},"released":{"type":"boolean"},"customerNumber":{"description":"The customer identity.","type":"string","nullable":true},"comment":{"description":"The comment.","type":"string","nullable":true},"abbreviation":{"description":"The company abbreviation.","type":"string","nullable":true},"categoryId":{"description":"The company category id.","type":"integer","nullable":true}},"type":"object"},"Country":{"title":"Country","properties":{"id":{"description":"The id of the country.","type":"string"},"nameDe":{"description":"The german name of the country.","type":"string"},"nameEn":{"description":"The english name of the country.","type":"string"},"code":{"description":"The code of the country.","type":"string"},"germanStatisticCode":{"description":"The german university statistic code of the country.","type":"string"},"austrianStatisticCode":{"description":"The austrian university statistic(BIS) code of the country.","type":"string"}},"type":"object"},"CourseSeriesLecturer":{"title":"CourseSeriesLecturer","properties":{"courseSeriesId":{"description":"The id of the course series.","type":"string"},"lecturerId":{"description":"The id of the lecturer profile.","type":"string"},"hoursPerWeek":{"description":"The hours per week for the lecturer in the course series.","type":"number","format":"float"}},"type":"object"},"CourseTicketAddCommand":{"title":"CourseTicketAdd","required":["courseLectureSeriesId","bookingId"],"properties":{"courseLectureSeriesId":{"description":"The course lecture series id","type":"integer"},"bookingId":{"description":"The student booking id","type":"integer"},"examAdmission":{"description":"Sets the exam admission for the course ticket","type":"boolean","default":false},"bookEventDates":{"description":"Assign student booking to existing events of course lecture series id","type":"boolean","default":false},"curriculumEntryId":{"description":"Manually set the curriculum entry id","type":"integer"}},"type":"object"},"CourseTickets":{"title":"CourseTicket","properties":{"id":{"description":"The id of the course ticket.","type":"string","nullable":true},"isBookEventDates":{"description":"Deprecated: This attribute is still required in v2 but it is not supported. It will be removed in v3.","type":"boolean","nullable":true},"isExamAdmission":{"description":"Is the student allowed to enrol the exam","type":"boolean","nullable":true}},"type":"object"},"CourseStatusRelations":{"title":"CourseStatusRelation","properties":{"courseId":{"description":"The id of the course.","type":"string"},"courseStatusId":{"description":"The id of the course-status.","type":"string"}},"type":"object"},"DataSourceAreas":{"title":"DataSourceArea","properties":{"id":{"description":"The id of the data source area.","type":"string"},"labelDe":{"description":"The german label of the data source area.","type":"string"},"labelEn":{"description":"The english label of the data source area.","type":"string"},"type":{"description":"The type of the data source area.","type":"string"},"moduleType":{"description":"The module type of the data source area if type is set to 8.","type":"string","nullable":true},"moduleArguments":{"description":"The arguments of the module.","type":"string","nullable":true},"dataSourceTabId":{"description":"The data source tab id of the data source area.","type":"string"},"infoTextDe":{"description":"The german info text of the data source area.","type":"string","nullable":true},"infoTextEn":{"description":"The english info text of the data source area.","type":"string","nullable":true},"linkedDataSourceId":{"description":"The linked data source id the data source area if the specific type is selected.","type":"string","nullable":true},"linkedDataSourceRelation":{"description":"The relation of the data source area.","type":"string","nullable":true},"linkedDataSourceReferenceField":{"description":"The reference field of the data source area.","type":"string","nullable":true},"visibilityRulesJson":{"description":"The visibilityRulesJson of the data source area.","type":"string","nullable":true},"columnLayoutType":{"description":"The column type of the data source area.","type":"integer","nullable":true}},"type":"object"},"DataSourceFieldOptionGroupRestrictions":{"title":"DataSourceFieldOptionGroupRestriction","properties":{"id":{"description":"The id of the data source field option group.","type":"string"},"fieldOptionId":{"description":"The labels of the data source field option group.","type":"string"}},"type":"object"},"DataSourceFieldOptionGroups":{"title":"DataSourceFieldOptionGroup","properties":{"id":{"description":"The id of the data source field option group.","type":"string"},"labelDe":{"description":"The labelDe of the data source field option group.","type":"string","nullable":true},"labelEn":{"description":"The labelEn of the data source field option group.","type":"string","nullable":true},"fieldOptionsJson":{"description":"The field options of the data source field option group.","type":"string","nullable":true}},"type":"object"},"DataSourceFieldOptionValues":{"title":"DataSourceFieldOptionValue","properties":{"id":{"description":"The id of the data source field option value.","type":"string"},"labelDe":{"description":"The german label of the data source field option value.","type":"string","nullable":true},"labelEn":{"description":"The english label of the data source field option value.","type":"string","nullable":true},"position":{"description":"The position of the data source field option value.","type":"integer","nullable":true}},"type":"object"},"DataSourceFields":{"title":"DataSourceField","properties":{"id":{"description":"The id of the data source field.","type":"string"},"name":{"description":"The name of the data source field.","type":"string","nullable":true},"labelDe":{"description":"The german label of the data source field.","type":"string","nullable":true},"labelEn":{"description":"The english label of the data source field.","type":"string","nullable":true},"areaId":{"description":"The area id of the data source field.","type":"integer"},"type":{"description":"The type of the data source field.","type":"string","nullable":true},"systemFieldId":{"description":"The system field id of the data source field.","type":"string","nullable":true},"isMandatory":{"description":"The mandatory status of the data source field."},"position":{"description":"The position of the data source field.","type":"integer"},"validationId":{"description":"The validation id of the data source field."},"infoDe":{"description":"The german info of the data source field.","type":"string","nullable":true},"infoEn":{"description":"The english info of the data source field.","type":"string","nullable":true},"columnLayoutPosition":{"description":"The column layout position of the data source field. Can either be 1 (left side) or 2 (right side).","type":"integer","nullable":true},"maximumFileSize":{"description":"The maximum file size, if type 'infopool-file' is selected.","type":"integer","nullable":true},"maximumFileCount":{"description":"The maximum file count, if type 'infopool-file' is selected.","type":"integer","nullable":true},"visibilityRulesJson":{"description":"The visibilityRulesJson of the data source field.","type":"string","nullable":true},"validationRulesJson":{"description":"The validationRulesJson of the data source field.","type":"string","nullable":true},"multiSelectMinOptions":{"description":"The minimum amount of options that have to be selected, if type 'multiselect' is selected.","type":"integer","nullable":true},"multiSelectMaxOptions":{"description":"The maximum amount of options that can to be selected, if type 'multiselect' is selected.","type":"integer","nullable":true}},"type":"object"},"DataSourceRecordLogs":{"title":"DataSourceRecordLog","properties":{"id":{"description":"The id of the data source record log.","type":"string"},"type":{"description":"The type of the data source record log.","type":"string"},"createdDate":{"description":"The created date of the data source record log.","type":"string"},"jsonValues":{"description":"The values of the data source record log.","type":"string","nullable":true}},"type":"object"},"DataSourceRecordSaveCommand":{"title":"DataSourceRecord","required":["dataSourceId","recordId"],"properties":{"dataSourceId":{"description":"The data source id","type":"integer","format":"integer"},"fields":{"type":"array","items":{"$ref":"#\/components\/schemas\/DataSourceRecordField"}},"recordId":{"description":"The data source record id","type":"integer","format":"integer"}},"type":"object"},"DataSourceRecordField":{"title":"DataSourceRecordField","required":["id","value"],"properties":{"id":{},"value":{"type":"array","items":{},"nullable":true}},"type":"object"},"DataSourceTabs":{"title":"DataSourceTab","properties":{"id":{"description":"The id of the data source tab.","type":"string"},"labelDe":{"description":"The german label of the data source tab.","type":"string","nullable":true},"labelEn":{"description":"The english label of the data source tab.","type":"string","nullable":true},"position":{"description":"The position of the data source tab.","type":"integer"}},"type":"object"},"DataSources":{"title":"DataSource","properties":{"id":{"description":"The id of the data source.","type":"string"},"name":{"description":"The name of the data source.","type":"string","nullable":true},"tableName":{"description":"The table name of the data source.","type":"string","nullable":true},"usage":{"description":"The usage of the data source. Current possible usages: courseOffer, financeData, internalApplicationData, newOnlineApplication, submission","type":"string","nullable":true}},"type":"object"},"DatabaseTableColumns":{"title":"DatabaseTableColumn","properties":{"id":{"description":"The id (name) of the database table column.","type":"string"}},"type":"object"},"DatabaseTables":{"title":"DatabaseTable","properties":{"id":{"description":"The id (name) of the database table.","type":"string"}},"type":"object"},"DocumentTypes":{"title":"DocumentType","properties":{"id":{"description":"The id of the document type.","type":"string"},"labelDe":{"description":"The german label of the document type.","type":"string","nullable":true},"labelEn":{"description":"The english label of the document type.","type":"string","nullable":true}},"type":"object"},"Documents":{"title":"Document","properties":{"id":{"description":"The id of the document.","type":"string"},"targetId":{"description":"The targeted id of the document.","type":"integer"},"subTargetId":{"description":"The targeted id of the document.","type":"integer","nullable":true}},"type":"object"},"DocumentsSelectDto":{"title":"Document","properties":{"id":{"description":"The id of the document.","type":"integer"},"label":{"description":"The label of the document.","type":"string"},"type":{"description":"The type of the document.","type":"string"},"customProperties":{"description":"The custom properties: type of the document.","type":"string","nullable":true}},"type":"object"},"Email":{"required":["sender","contentType"],"properties":{"profileIds":{"title":"Profile Ids","type":"array","items":{"type":"integer"}},"emailAddresses":{"title":"Email addresses","type":"array","items":{"type":"string"}},"sender":{"description":"The sender, e.g. 'Example \\<info@example.com\\>'.","type":"string","format":"string"},"templateId":{"description":"The template id for a text template.","type":"integer","format":"integer"},"subject":{"description":"The email subject.","type":"string","format":"string"},"content":{"description":"The email content.","type":"string","format":"string"},"contentType":{"description":"The content type: text or html.","type":"string","format":"string"},"language":{"description":"The language for replacing the placeholders: de or en.","type":"string","format":"string"},"bccEmailAddress":{"description":"The BCC email address","type":"string","format":"string","nullable":true},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/EmailAttachment"}}},"type":"object"},"EmailAttachment":{"properties":{"fileName":{"type":"string"},"fileContentBase64Encoded":{"type":"string"}},"type":"object"},"Event":{},"EventDto":{"properties":{"id":{"type":"integer"},"date":{"type":"string"},"startTime":{"type":"string"},"endTime":{"type":"string"},"titleDe":{"type":"string","nullable":true},"titleEn":{"type":"string","nullable":true},"customEventTypeId":{"type":"integer"},"planningStatusId":{"type":"integer"},"comment":{"type":"string","nullable":true},"roomIds":{"type":"array","items":{"type":"integer"}},"customId":{"type":"string","nullable":true},"link":{"type":"string","nullable":true}},"type":"object"},"EventDate":{"title":"EventDate","properties":{"id":{"description":"Unique ID of the eventDate.","type":"string"},"eventSeriesId":{"description":"Unique ID of the eventSeries.","type":"integer"},"startTime":{"description":"Starte time of the eventDate."},"endTime":{"description":"End time of the eventDate."},"date":{"description":"Date of the eventDate"},"allDay":{"description":"Regulates if the eventDate is all day (00:00 - 23:59)","type":"boolean"},"readOnly":{"description":"Regulates if the eventDate is editable. This value is not accessable trough the API","type":"boolean"},"customEventTypId":{"description":"Unique ID of the customeEventTypeId. A label specified by the customer based on an AC5 eventType.","type":"integer"},"title":{"description":"Title of the eventDate, only accesseable if not a lecture eventDate.","type":"string","nullable":true},"lectureSeriesPartId":{"description":"Unique ID of the lectureSeriesPart.","type":"integer","nullable":true},"teachingUnits":{"description":"Amount of teachingUnits for this eventDate.","type":"integer","nullable":true},"comment":{"description":"Arbitrary comment.","type":"string","nullable":true},"comment2":{"description":"Arbitrary comment.","type":"string","nullable":true},"planningGroupIds":{"description":"ID's of the planningGroups, configured in AC5","type":"array","items":{"type":"integer"},"nullable":true},"roomIds":{"description":"ID's of the rooms, configured in AC5","type":"array","items":{"type":"integer"},"nullable":true},"lecturerIds":{"description":"ID's of the lecturers, configured in AC5.","type":"array","items":{"type":"integer"},"nullable":true}},"type":"object"},"GkvPendingMessages":{"title":"GkvPendingMessage","properties":{"id":{"description":"The id of the gkv pending message.","type":"string"},"handled":{"description":"The handled attribute of the gkv pending message.","type":"boolean"},"handledDate":{"description":"The handled date of the gkv pending message.","type":"string","nullable":true},"receivedDate":{"description":"The received date of the gkv pending message.","type":"string","nullable":true},"firstname":{"description":"The firstname of the gkv pending message.","type":"string","nullable":true},"lastname":{"description":"The lastname of the gkv pending message.","type":"string","nullable":true},"dateOfBirth":{"description":"The date of birth of the gkv pending message.","type":"string","nullable":true},"healthInsuranceNumber":{"description":"The health insurance number of the gkv pending message.","type":"string","nullable":true},"instituteIdentification":{"description":"The institute identification of the gkv pending message.","type":"string","nullable":true},"messageType":{"description":"The message status of the gkv pending message as a number.","type":"string","nullable":true},"message":{"description":"The message of the gkv pending message.","type":"string","nullable":true},"responseId":{"description":"The response id of the gkv pending message.","type":"string","nullable":true},"selectedProfileId":{"description":"The selected profile id of the gkv pending message.","type":"integer","nullable":true},"assignedProfileId":{"description":"The assigned profile id of the gkv pending message.","type":"integer","nullable":true},"messageContent":{"description":"The xml content of the gkv pending message.","type":"string","nullable":true},"instituteString":{"description":"The institute string of the gkv pending message.","type":"string","nullable":true}},"type":"object"},"GlobalFileSyncs":{"title":"GlobalFileSync","properties":{"id":{"description":"The id of the global file sync.","type":"string","nullable":true},"sourceArea":{"description":"The source area of the global file sync.","type":"string"},"name":{"description":"The name of the global file sync.","type":"string"},"extension":{"description":"The name of the global file sync.","type":"string"},"externalLink":{"description":"The name of the global file sync.","type":"string","nullable":true},"createdAt":{"description":"The created date of the global file sync.","type":"string"},"updatedAt":{"description":"The updated date of the global file sync.","type":"string","nullable":true},"transferredAt":{"description":"The transferred date of the global file sync.","type":"string","nullable":true},"deletedAt":{"description":"The deleted date of the global file sync.","type":"string","nullable":true}},"type":"object"},"GradeAnnotation":{"title":"GradeAnnotation","properties":{"id":{"description":"The id of the grade annotation.","type":"string","nullable":true},"abbreviation":{"description":"The abbreviation of the grade annotation.","type":"string"},"labelDe":{"description":"The german name of the grade annotation.","type":"string"},"labelEn":{"description":"The english name of the grade annotation.","type":"string"},"evaluationTypeId":{"description":"The evaluation selection of the grade annotation.","type":"integer"},"examinationAttemptTypeId":{"description":"The examination attempt of the grade annotation.","type":"integer"},"isMedicalCertificate":{"description":"The value if the grade annotation has a medical certificate.","type":"boolean"},"isSelectableByLecturer":{"description":"The value if the grade annotation is selectable by the lecturer.","type":"boolean"},"isVisibleForLecturer":{"description":"The value if the grade annotation is visible for the lecturer.","type":"boolean"},"isActive":{"description":"The value if the grade annotation is active.","type":"boolean"},"isLockExamRegistration":{"description":"The value if the exam registration is locked.","type":"boolean"},"isLockExamCancellation":{"description":"The value if the exam cancellation is locked.","type":"boolean"}},"type":"object"},"GradeAnnotationRelations":{"title":"GradeAnnotationRelation","properties":{"gradeId":{"description":"The id of the grade.","type":"string","nullable":true},"gradeAnnotationId":{"description":"The id of the grade-annotation.","type":"string","nullable":true}},"type":"object"},"HealthInsuranceInstitutes":{"title":"HealthInsuranceInstitute","properties":{"identification":{"description":"The identification of the health insurance institute.","type":"string"},"costUnit":{"description":"The cost unit of the health insurance institute.","type":"string"},"costUnitName":{"description":"The cost unit name of the health insurance institute.","type":"string"},"replacementNumber":{"description":"The replacement number of the health insurance institute.","type":"string","nullable":true},"davNumber":{"description":"The dav number of the health insurance institute.","type":"string","nullable":true},"validUntil":{"description":"The valid until date of the health insurance institute.","type":"string","nullable":true}},"type":"object"},"HealthInsuranceProfile":{"title":"HealthInsuranceProfile","properties":{"profileId":{"description":"The ProfileId for the student to be reported.","type":"integer"},"instituteIdentification":{"description":"The Institution Identification of the Health Insurance Profile: BN","type":"string","nullable":true},"healthInsuranceNumber":{"description":"The health Insurance Number of the Health Insurance Profile.","type":"string","nullable":true},"attestation":{"description":"The attestation state of the student.\n     *      ['attestation_needed', 'attestation_not_needed', 'attestation_exempt']","type":"string","nullable":true},"status":{"description":"The staus of the Health Insurance report.\n     *      ['not_set','status_insurance_active', 'status_insurance_inactive']","type":"string","nullable":true},"lastUpdated":{"description":"last updated"}},"type":"object"},"HealthInsuranceProfileCommunicationLog":{"title":"HealthInsuranceProfileCommunicationLog","properties":{"id":{"description":"The id of the HealthInsuranceProfileCommunicationLog.","type":"string"},"date":{"description":"The date of the HealthInsuranceProfileCommunicationLog.","type":"string"},"statusId":{"description":"The status id of the HealthInsuranceProfileCommunicationLog.","type":"integer"},"profileId":{"description":"The profile id of the HealthInsuranceProfileCommunicationLog. It is set to null if deleted.","type":"integer","nullable":true},"comment":{"description":"The comment of the HealthInsuranceProfileCommunicationLog.","type":"string","nullable":true},"requestId":{"description":"The Id of the request sent to the health insurance.","type":"string","nullable":true},"responseId":{"description":"The Id from the answer of the health insurance.","type":"string","nullable":true},"messageContent":{"description":"The message content of the HealthInsuranceProfileCommunicationLog.","type":"string","nullable":true},"triggeredBy":{"description":"The user id who triggered the log entry.","type":"integer","nullable":true},"cancelledById":{"description":"The id of the log entry which cancelled this log entry. Null if not cancelled.","type":"integer","nullable":true}},"type":"object"},"HealthInsuranceReportingInstitute":{"title":"HealthInsuranceReportingInstitute","properties":{"id":{"description":"The id of the healthInsuranceReportingInstitute."},"siteIds":{"description":"The siteIds of the healthInsuranceReportingInstitute."},"senderNumber":{"description":"The senderNumber of the healthInsuranceReportingInstitute."},"senderUniversity":{"description":"The senderUniversity of the healthInsuranceReportingInstitute."},"universityName":{"description":"The name of the university."},"contactName":{"description":"The name of the contact person."},"addressType":{"description":"The id of the healthinsurancereportinginstitute."},"publicKey":{"description":"The public key."},"privateKey":{"description":"The private key."},"certificate":{"description":"The certificate."}},"type":"object"},"InvoiceCollections":{"title":"InvoiceCollections","properties":{"id":{"description":"The fake id of this collection. Always 0.","type":"string"},"invoices":{"description":"The invoices.","type":"array","items":{"$ref":"#\/components\/schemas\/Invoices"}}},"type":"object"},"InvoicePositions":{"title":"InvoicePositions","properties":{"id":{"description":"The id of the invoice position.","type":"string"},"comment":{"description":"The comment of the invoice position.","type":"string","nullable":true},"quantity":{"description":"The quantity of the invoice position.","type":"integer"},"price":{"description":"The price of the invoice position.","type":"number","format":"float"},"taxId":{"description":"The tax id of the invoice position.","type":"integer"},"profitCenterId":{"description":"The profit center id of the invoice position.","type":"integer","nullable":true},"revenueAccountId":{"description":"The revenue account id of the invoice position.","type":"integer","nullable":true}},"type":"object"},"Invoices":{"title":"Invoice","properties":{"id":{"description":"The id of the invoice.","type":"string"},"profileId":{"description":"The profile id of the invoice.","type":"integer","nullable":true},"companyId":{"description":"The company id of the invoice.","type":"integer","nullable":true},"bookingId":{"description":"The booking id of the invoice.","type":"integer","nullable":true},"siteId":{"description":"The site id of the invoice.","type":"integer"},"invoiceDate":{"description":"The invoice date of the invoice.","type":"string"},"confirmationOfPaymentDocumentId":{"description":"The confirmation of payment document id of the invoice.","type":"integer","nullable":true},"dueDate":{"description":"The due date of the invoice.","type":"string"},"bankAccountId":{"description":"The bank account id of the invoice.","type":"integer"},"addressId":{"description":"The address id of the invoice.","type":"integer"},"currencyCode":{"description":"The currency code of the invoice.","type":"string"},"profitCenterId":{"description":"The profit center id of the invoice.","type":"integer","nullable":true},"documentId":{"description":"The document id of the invoice.","type":"integer"},"positions":{"description":"The positions of the invoice.","type":"array","items":{"$ref":"#\/components\/schemas\/InvoicePositions"}},"isPaymentPlan":{"description":"Has the invoice a payment plan.","type":"boolean"},"paymentPlanDueDate":{"description":"The due date of the payment plan.","type":"string","nullable":true},"paymentPlanCount":{"description":"The number of positions of the payment plan.","type":"integer","nullable":true},"comment":{"description":"The comment of the invoice.","type":"string","nullable":true},"isTriggerMatriculation":{"description":"Does payment of the invoice trigger matriculation.","type":"boolean"},"isTriggerReRegistration":{"description":"Does payment of the invoice trigger re-registration.","type":"boolean"},"createdDate":{"description":"The creation date of the invoice.","type":"string","nullable":true},"showRecipient":{"description":"Is the recipient shown in a company invoice.","type":"boolean"}},"type":"object"},"InvoicesStatusChangeBulk":{"title":"InvoicesStatusChangeBulk","properties":{"statusId":{"description":"The status id to change to.","type":"integer"},"sendMail":{"description":"Send a mail on status change.","type":"boolean"},"invoiceIds":{"description":"The ids of the invoices to change the status for","type":"array","items":{"type":"integer"}}},"type":"object"},"LecturerContractEmploymentAvailabilities":{"title":"LecturerContractEmploymentAvailability","properties":{"id":{"description":"The id of the lecturer contract employment availability.","type":"string"},"startTime":{"description":"The start time contract employment availability.","type":"string"},"endTime":{"description":"The until time contract employment availability.","type":"string"}},"type":"object"},"LecturerContractEmployments":{"title":"LecturerContractEmployment","properties":{"id":{"type":"string"},"teachingUnits":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"occupationTypeId":{"type":"string"},"capacity":{"type":"string","nullable":true}},"type":"object"},"LecturerContracts":{"title":"LecturerContracts","properties":{"id":{"description":"The id of the lecturer contract.","type":"string","nullable":true},"profileId":{"description":"The id of the profile.","type":"string"},"siteId":{"description":"The id of the site.","type":"string","nullable":true},"personnelNumber":{"type":"string","nullable":true},"contractNumber":{"type":"string","nullable":true},"bisSocialInsuranceNumber":{"type":"integer","nullable":true},"bankName":{"type":"string","nullable":true},"iban":{"type":"string","nullable":true},"bic":{"type":"string","nullable":true},"isFullTime":{"type":"boolean"},"lecturerContractStatusId":{"description":"The id of the status.","type":"string","nullable":true},"hasHabilitation":{"type":"boolean"}},"type":"object"},"NotificationBanners":{"title":"NotificationBanner","properties":{"id":{"description":"The id of the notification banner.","type":"string"},"text":{"description":"The text of the notification banner.","type":"string","nullable":true},"isActive":{"description":"The active status of the notification banner.","type":"integer","nullable":true},"colorType":{"description":"The color type of the notification banner.","nullable":true},"icon":{"description":"The icon of the notification banner.","nullable":true}},"type":"object"},"OnlineExamEnrolments":{"title":"OnlineExamEnrolment","properties":{"id":{"description":"The id of the online exam enrolment.","type":"string","nullable":true},"bookingId":{"description":"The booking id.","type":"integer","nullable":true},"moduleVersionId":{"description":"The module version id.","type":"integer","nullable":true},"subjectVersionId":{"description":"The subject version id.","type":"integer","nullable":true},"enrolmentDateTime":{"description":"The enrolment date time. If no date time is set, the current date time is used.","type":"string","nullable":true},"examStartDateTime":{"description":"The exam start date time.","type":"string","nullable":true},"examEndDateTime":{"description":"The exam end date time.","type":"string","nullable":true}},"type":"object"},"Payment":{"title":"Payment","required":["invoiceNumber","currencyCode","amount","date","language"],"properties":{"invoice-number":{"description":"The number of the invoice","type":"string"},"currency-code":{"description":"Currency code according to ISO 4217 ex. 'EUR', 'USD'","type":"string"},"amount":{"description":"Payment amount","type":"number","format":"float"},"date":{"description":"Payment date in format yyyy-mm-dd","format":"date"},"paid":{"description":"Marks the invoice as payd (optional)","type":"boolean","default":false},"comment":{"description":"Payment comment","type":"string","default":null,"nullable":true},"language":{"description":"language for logs de|en","type":"string"}},"type":"object"},"PaymentModelPreviews":{"title":"PaymentModelPreview","properties":{"id":{"description":"The id of the payment-model.","type":"string"},"name":{"description":"The name of the payment-model.","type":"string","nullable":true},"bookingType":{"description":"The bookingType of the payment-model.","type":"string","nullable":true},"positions":{"description":"The positions of the payment-model.","type":"array","items":{"type":"Contains objects with semesterText, columns, and rows. Each columns entry defines a column with id and label, while rows is a list of arrays where each item maps a columnId to a value"}}},"type":"object"},"ProfessionalBackground":{"title":"ProfessionalBackground","properties":{"id":{"description":"The id of the professional background.","type":"string"},"companyId":{"description":"The id of company for the professional background.","type":"string"},"profileId":{"description":"The id of profile for the professional background.","type":"string"},"typeId":{"description":"The id of type for the professional background.","type":"string"},"addressId":{"description":"The id of the address for the professional background.","type":"string"},"department":{"description":"The department for the professional background.","type":"string"},"position":{"description":"The position for the professional background.","type":"string"},"room":{"description":"The room of the professional background.","type":"string"},"description":{"description":"The description for the professional background.","type":"string"},"startDate":{"description":"The start date for the professional background.","type":"string"},"endDate":{"description":"The end date for the professional background.","type":"string"}},"type":"object"},"ProfileBankDetails":{"title":"ProfileBankDetails","properties":{"id":{"description":"The profileId of the ProfileBankDetails record.","type":"string","nullable":true},"databaseId":{"description":"The database id of the ProfileBankDetails record.","type":"string","nullable":true},"profileId":{"description":"The profileId of the ProfileBankDetails record.","type":"string"},"iban":{"description":"The IBAN of the ProfileBankDetails record.","type":"string"},"bic":{"description":"The BIC of the ProfileBankDetails record.","type":"string"}},"type":"object"},"Profiles":{"title":"Profile","properties":{"id":{"description":"The id of the profile.","type":"integer","nullable":true},"firstname":{"description":"The firstname of the profile.","type":"string","nullable":true},"isCampusWEBAccess":{"description":"Has the profile access to CampusWEB?","type":"boolean"},"lastname":{"description":"The lastname of the profile.","type":"string","nullable":true}},"type":"object"},"ProfitCenterAdd":{"required":["name","number","siteIds"],"properties":{"name":{"description":"The name of the profit center","type":"string"},"number":{"description":"The number of the profit center (used for invoice number creation)","type":"string"},"site-ids":{"description":"The site ids wich are linked to this profit center","type":"array","items":{"type":"integer"}},"study-program-ids":{"description":"The study program ids wich are linked to this profit center (can be removed from request, because it's optional)","type":"array","items":{"type":"integer"}}},"type":"object"},"RequestFormProfileComments":{"title":"RequestFormProfileComment","properties":{"id":{"description":"The id of the request form profile comment.","type":"string"},"requestFormProfileId":{"description":"The request form profile id of the request form profile comment.","type":"string"},"text":{"description":"The test of the request form profile comment.","type":"string"},"public":{"description":"Is the request form profile comment visible to the student.","type":"boolean"}},"type":"object"},"RequestFormProfiles":{"title":"RequestFormProfile","properties":{"id":{"description":"The id of the request form profile.","type":"string"},"profileId":{"description":"The profile id of the request form profile.","type":"integer"},"requestId":{"description":"The request id of the request form profile.","type":"integer"},"statusId":{"description":"The status id of the request form profile.","type":"integer","nullable":true},"date":{"description":"The date of the request form profile.","type":"string","nullable":true},"formProcessId":{"description":"The form process id of the request form profile.","type":"integer","nullable":true},"submitDate":{"description":"The submit date of the request form profile.","type":"string","nullable":true},"editedProfileId":{"description":"The edited profile id of the request form profile.","type":"integer","nullable":true}},"type":"object"},"RevenueAccounts":{"title":"RevenueAccount","properties":{"id":{"description":"The id of the revenue account.","type":"string","nullable":true},"revenueAccountNumber":{"description":"The account number of the revenue account.","type":"string"},"active":{"description":"Is the revenue account active.","type":"boolean"},"labelEn":{"description":"The english label of the revenue account.","type":"string"},"labelDe":{"description":"The german label of the revenue account.","type":"string"},"studyProgramId":{"description":"The id of the study program.","type":"integer","nullable":true},"financialPaymentModelId":{"description":"The id of the financial payment model.","type":"integer","nullable":true},"financialProfitCenterId":{"description":"The id of the financial profit center.","type":"integer","nullable":true},"comment":{"description":"The comment of the revenue account.","type":"string"}},"type":"object"},"StatisticAustria":{"title":"statistic-austria"},"StatisticValidations":{"title":"StatisticValidation","properties":{"profileId":{"description":"The id of the profile.","type":"string"}},"type":"object"},"StudyPrograms":{"title":"StudyProgram","properties":{"id":{"description":"The id of the study program.","type":"string"},"abbreviation":{"description":"The name de of the study program.","type":"string","nullable":true}},"type":"object"},"ZensusSettings":{"title":"ZensusSetting","properties":{"id":{"description":"The id of the zensus setting.","type":"string"},"webUrl":{"description":"The baseurl of the zensus setting.","type":"string"},"shortlink":{"description":"The shortlink of the zensus setting.","type":"string"},"username":{"description":"The username of the zensus setting.","type":"string"},"password":{"description":"The password of the zensus setting.","type":"string"},"isActive":{"description":"Is the Zensus setting active.","type":"boolean"},"releaseDate":{"description":"The date when the course are to be send.","type":"string","nullable":true}},"type":"object"}},"responses":{"400":{"description":"Bad Request"},"403":{"description":"Forbidden"}}},"tags":[{"name":"access-groups [Beta]","description":"access-groups [Beta]"},{"name":"bookings [Beta]","description":"bookings [Beta]"},{"name":"booking-statistic-austria","description":"booking-statistic-austria"},{"name":"cohorts [Beta]","description":"cohorts [Beta]"},{"name":"colors [Beta]","description":"colors [Beta]"},{"name":"Companies [Beta]","description":"Companies [Beta]"},{"name":"Countries","description":"Countries"},{"name":"course-series-lecturers [Beta]","description":"course-series-lecturers [Beta]"},{"name":"course-tickets","description":"course-tickets"},{"name":"course-tickets [Beta]","description":"course-tickets [Beta]"},{"name":"course-status-relations [Beta]","description":"course-status-relations [Beta]"},{"name":"data-source-areas [Beta]","description":"data-source-areas [Beta]"},{"name":"data-source-field-option-group-restrictions [Beta]","description":"data-source-field-option-group-restrictions [Beta]"},{"name":"data-source-field-option-groups [Beta]","description":"data-source-field-option-groups [Beta]"},{"name":"data-source-field-option-values","description":"data-source-field-option-values"},{"name":"data-source-fields [Beta]","description":"data-source-fields [Beta]"},{"name":"data-source-record-logs","description":"data-source-record-logs"},{"name":"data-source-records [Beta]","description":"data-source-records [Beta]"},{"name":"data-source-tabs [Beta]","description":"data-source-tabs [Beta]"},{"name":"data-sources [Beta]","description":"data-sources [Beta]"},{"name":"database-table-columns [Beta]","description":"database-table-columns [Beta]"},{"name":"document-types","description":"document-types"},{"name":"documents","description":"documents"},{"name":"emails","description":"emails"},{"name":"events","description":"events"},{"name":"event-dates","description":"event-dates"},{"name":"event-series","description":"event-series"},{"name":"financial-documents","description":"financial-documents"},{"name":"gkv-pending-messages","description":"gkv-pending-messages"},{"name":"global-file-syncs [Beta]","description":"global-file-syncs [Beta]"},{"name":"Grade-Annotations [Beta]","description":"Grade-Annotations [Beta]"},{"name":"grade-annotation-relations [Beta]","description":"grade-annotation-relations [Beta]"},{"name":"grades","description":"grades"},{"name":"health-insurance-institutes","description":"health-insurance-institutes"},{"name":"health-insurance-profiles [Beta]","description":"health-insurance-profiles [Beta]"},{"name":"health-insurance-profile-communication-logs [Beta]","description":"health-insurance-profile-communication-logs [Beta]"},{"name":"health-insurance-reporting-institutes [Beta]","description":"health-insurance-reporting-institutes [Beta]"},{"name":"icons [Beta]","description":"icons [Beta]"},{"name":"invoiceCollections","description":"invoiceCollections"},{"name":"invoice-queue-entries","description":"invoice-queue-entries"},{"name":"invoices","description":"invoices"},{"name":"lecturer-contract-employment-availabilities","description":"lecturer-contract-employment-availabilities"},{"name":"lecturer-contract-employments [Beta]","description":"lecturer-contract-employments [Beta]"},{"name":"lecturer-contracts [Beta]","description":"lecturer-contracts [Beta]"},{"name":"Maintenance [Dev-Only]","description":"Maintenance [Dev-Only]"},{"name":"navigation [Dev-Only]","description":"navigation [Dev-Only]"},{"name":"notification-banners [Dev-Only]","description":"notification-banners [Dev-Only]"},{"name":"online-exam-enrolments","description":"online-exam-enrolments"},{"name":"payments","description":"payments"},{"name":"PaymentModelPreviews","description":"PaymentModelPreviews"},{"name":"Professional-Backgrounds [Beta]","description":"Professional-Backgrounds [Beta]"},{"name":"profile-bank-details [Dev-Only]","description":"profile-bank-details [Dev-Only]"},{"name":"profiles [Beta]","description":"profiles [Beta]"},{"name":"profit-centers","description":"profit-centers"},{"name":"request-form-profile-comments","description":"request-form-profile-comments"},{"name":"request-form-profiles","description":"request-form-profiles"},{"name":"revenue-accounts","description":"revenue-accounts"},{"name":"revenue-accounts [Dev-Only]","description":"revenue-accounts [Dev-Only]"},{"name":"statistic-austria  [Dev-Only]","description":"statistic-austria  [Dev-Only]"},{"name":"statistic-validations [Dev-Only]","description":"statistic-validations [Dev-Only]"},{"name":"student-profiles [Beta]","description":"student-profiles [Beta]"},{"name":"subjectVersion","description":"subjectVersion"},{"name":"submissions","description":"submissions"},{"name":"task-types [Beta]","description":"task-types [Beta]"},{"name":"translation-placeholders [Dev-Only]","description":"translation-placeholders [Dev-Only]"},{"name":"zensus-settings [Dev-Only]","description":"zensus-settings [Dev-Only]"}]}