{"swagger":"2.0","host":false,"tags":[{"name":"Calendars","description":"Controller serves for calendar API the User/PU/Admins can Download"},{"name":"Categories","description":"APIs serving for categories management"},{"name":"Classrooms","description":"This Controller serves the course management API to manage all the operations related to the Classroom entity"},{"name":"CourseArchived","description":"Archived courses and training materials API endpoints"},{"name":"Courses","description":"Controller serves for course management API the Admins can modify the course, learning plans, catalogs, etc."},{"name":"Events","description":"Descrizione events"},{"name":"Instructors","description":"This Controller serves the course management API to manage all the operations related to the Instructor entity"},{"name":"Sessions","description":"Descrizione sessions controller"},{"name":"Thumbnails","description":"Controller serves for thumbnails management API the Admins can modify the thumbnails"}],"info":{"title":"Course","version":"1.0","description":""},"paths":{"/course/v1/categories":{"post":{"tags":["Categories"],"operationId":"Categories./course/v1/categories","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCategoriesCreateSchema"}}],"summary":"Create a new course category","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCategoriesCreateResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Error while processing the requested operation"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/categories/{id}":{"delete":{"tags":["Categories"],"operationId":"Categories./course/v1/categories/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the category that needs to be delete"}],"summary":"Delete a category","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCategoriesDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1002":"You can't delete a category that contains sub-categories","1003":"You can't delete the root category"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Categories"],"operationId":"Categories./course/v1/categories/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCategoriesUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the category"}],"summary":"Update a category attributes","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCategoriesUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"{0} is not valid","1002":"Cannot edit the root category","1003":"Cannot move the category in its subcategory","1004":"Can not make a category to be a parent of itself","1005":"Parent category with {ID} is not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Categories"],"operationId":"Categories./course/v1/categories/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the category"}],"summary":"Get category details","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCategoriesViewResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/classrooms/{classroom_id}/freebusy":{"post":{"tags":["Classrooms"],"operationId":"Classrooms./course/v1/classrooms/{classroom_id}/freebusy","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseClassroomsFreeBusySchema"}},{"in":"path","name":"classroom_id","type":"integer","required":true,"description":"ID of an existing classroom"}],"summary":"Checks classroom availability given a time-frame","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseClassroomsFreeBusyResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Classroom not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by name/description (contains)"},{"in":"query","enum":["archived_course_id","archived_date","name"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""}],"summary":"List archived courses","last_modified_date":"2025.10.22","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: page","1002":"Invalid parameter: page_size","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{id}/details":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{id}/details","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the archived course"}],"summary":"Get archived course details","last_modified_date":"2025.10.24","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDetailsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Archived course not found","1001":"Invalid parameter: id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{archived_course_id}/training_materials":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{archived_course_id}/training_materials","parameters":[{"in":"path","name":"archived_course_id","type":"integer","required":true,"description":"ID of an existing course archived"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","enum":["archived_course_training_material_id","name","type"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by training material name (contains)"}],"summary":"List archived course training materials","last_modified_date":"2025.10.27","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseTrainingMaterialsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: page","1002":"Invalid parameter: page_size","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir","1007":"Archived course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{archived_course_id}/enrolments":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{archived_course_id}/enrolments","parameters":[{"in":"path","name":"archived_course_id","type":"integer","required":true,"description":"ID of an existing course archived"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","enum":["archived_enrollment_course_id","username","archive_date","archived_by","enrolment_status_code","enrolment_status_label"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by username"}],"summary":"List archived course enrolments","last_modified_date":"2025.11.17","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseEnrolmentsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: page","1002":"Invalid parameter: page_size","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir","1007":"Archived course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{archived_course_id}/additional-fields":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{archived_course_id}/additional-fields","parameters":[{"in":"path","name":"archived_course_id","type":"integer","required":true,"description":"ID of an existing course archived"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","enum":["name","type"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by name"}],"summary":"List archived course additional fields","last_modified_date":"2025.10.30","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseAdditionalFieldsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: page","1002":"Invalid parameter: page_size","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir","1007":"Archived course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{archived_course_id}/sessions":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{archived_course_id}/sessions","parameters":[{"in":"path","name":"archived_course_id","type":"integer","required":true,"description":"ID of an existing course archived"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","enum":["session_id","session_name","session_start_date","session_end_date"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by session name"}],"summary":"List archived course sessions","last_modified_date":"2025.11.10","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseSessionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: page","1002":"Invalid parameter: page_size","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir","1007":"Archived course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{archived_course_id}/catalogs":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{archived_course_id}/catalogs","parameters":[{"in":"path","name":"archived_course_id","type":"integer","required":true,"description":"ID of an existing course archived"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","enum":["catalog_name"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by catalog name"}],"summary":"List archived course catalogs","last_modified_date":"2025.11.24","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseCatalogsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: page","1002":"Invalid parameter: page_size","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir","1007":"Archived course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/enrolments/{record_id}":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/enrolments/{record_id}","parameters":[{"in":"path","name":"record_id","type":"string","required":true,"description":"UUID of the archived enrollment (hex with dashes)"}],"summary":"Get archived course enrollment details","last_modified_date":"2025.11.18","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedEnrollmentDetailsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: record_id","1008":"Archived enrollment not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{archived_course_id}/certificate-templates":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{archived_course_id}/certificate-templates","parameters":[{"in":"path","name":"archived_course_id","type":"integer","required":true,"description":"ID of an existing course archived"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","enum":["template_name"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by template name"}],"summary":"List archived course certificate templates","last_modified_date":"2025.11.24","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseCertificateTemplatesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: page","1002":"Invalid parameter: page_size","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir","1007":"Archived course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{archived_course_id}/channels":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{archived_course_id}/channels","parameters":[{"in":"path","name":"archived_course_id","type":"integer","required":true,"description":"ID of an existing course archived"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","enum":["name"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by channel name"}],"summary":"List archived course channels","last_modified_date":"2025.11.22","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseChannelsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: page","1002":"Invalid parameter: page_size","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir","1007":"Archived course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/{archived_course_id}":{"delete":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/{archived_course_id}","parameters":[{"in":"path","name":"archived_course_id","type":"integer","required":true,"description":"ID of the archived course to delete"}],"summary":"Delete a specific archived course","last_modified_date":"2025.12.02","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedDeleteArchivedCourseResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: archived_course_id","1007":"Archived course not found","1401":"Archived course deletion is not allowed for the current state"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archived/dependencies":{"get":{"tags":["CourseArchived"],"operationId":"CourseArchived./course/v1/courses/archived/dependencies","parameters":[{"in":"query","collectionFormat":"brackets","items":{"type":"int"},"name":"course_id","type":"array","required":true,"description":"List of course IDs to check"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page (1-based). Default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Items per page. Default as configured"},{"in":"query","enum":["course_id","course_name"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to filter by course name or dependency name"}],"summary":"Get the soon-to-be-archived courses dependencies","last_modified_date":"2026.01.07","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDependenciesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter: course_id","1002":"Invalid parameter: course_id","1003":"Invalid parameter: sort_attr","1004":"Invalid parameter: sort_dir"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/batch":{"delete":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesDeleteSchema"}}],"summary":"Batch Course Delete","last_modified_date":"2026.01.07","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1010":"The processing requires {X} operations, but the maximum allowed is {Y}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesBatchSchema"}}],"summary":"Batch Course Update","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesBatchResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"A fulltext search to filter the results for. Will search in the course title, code or uidCourse fields"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter and return only this types of entities: possible values for each element in the array: elearning, classroom, learning_plan. Default value: elearning, classroom"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"status","type":"array","required":false,"description":"Filter and return only courses or LPs, that match this status. Possible value for each element: published, in_maintenance"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"notEnrolledInSessions","type":"array","required":false,"description":"If set to 1: filter users not enrolled in any sessions, 0: no filter"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language","type":"array","required":false,"description":"Filter and return only courses that have this language. Does not have any effects over Learning Plans being returned (if any are returned). Possible values: en, bg, it or any other lang code that platform has enabled"},{"in":"query","name":"excluded_courses_ids","type":"string","required":false,"description":"Courses that must be explicitly excluded from the search, in the form of a comma-separated list of numeric IDs. Example: &quot;1,2,3,100,200,300&quot;."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"skill_codes","type":"array","required":false,"description":"Array of skill codes"},{"in":"query","name":"exclude_enrolled_count","type":"boolean","required":false,"description":"If true, skips the calculation of enrollment counts for courses to improve performance. When skipped, the &#039;enrolled_count&#039; field in the response will be 0. Defaults to false."},{"in":"query","collectionFormat":"brackets","items":{"type":"int"},"name":"updated_by_ids","type":"array","required":false,"description":"Array of updater ids"},{"in":"query","name":"courses_without_updaters","type":"boolean","required":false,"description":"Filter response including also courses without updaters"},{"in":"query","name":"extra_filters","type":"object","required":false,"description":"Additional optional filters to be applied over the returned result. Example: {&quot;enrollments&quot;: {&quot;criteria&quot;: enum(&quot;more_than&quot;, &quot;less_than&quot;, &quot;equal_to&quot;), &quot;value&quot;: integer}, &quot;waiting_users&quot;: {&quot;criteria&quot;: enum(&quot;more_than&quot;, &quot;lass_than&quot;, &quot;equal_to&quot;), &quot;value&quot;: integer}, &quot;session_waiting_users&quot;: {&quot;criteria&quot;: enum(&quot;more_than&quot;, &quot;less_than&quot;, &quot;equal_to&quot;), &quot;value&quot;: integer}, &quot;for_sale&quot;: {&quot;criteria&quot;: enum(&quot;equal_to&quot;), &quot;value&quot;: boolean}, &quot;imported_from_content_marketplace&quot;: {&quot;criteria&quot;: enum(&quot;equal_to&quot;), &quot;value&quot;: boolean}, &quot;course_expiring&quot;: {&quot;criteria&quot;: enum(&quot;equal_to&quot;), &quot;value&quot;: boolean}, &quot;course_expired&quot;: {&quot;criteria&quot;: enum(&quot;equal_to&quot;), &quot;value&quot;: boolean}, &quot;code&quot;: {&quot;criteria&quot;: enum(&quot;equal_to&quot;, &quot;contains&quot;), &quot;value&quot;: string}, &quot;has_esignature_enabled&quot;: {&quot;criteria&quot;: enum(&quot;equal_to&quot;), &quot;value&quot;: boolean}, &quot;category&quot;: {&quot;criteria&quot;: &quot;in_array&quot;, &quot;value&quot;: [{&quot;id&quot;: integer, &quot;include_descendants&quot;: boolean}]}, &quot;outdated&quot;: {&quot;criteria&quot;: enum(&quot;more_than&quot;), &quot;value&quot;: integer}, &quot;certificate&quot;: {&quot;criteria&quot;: enum(&quot;equal_to&quot;), &quot;value&quot;: boolean}}"},{"in":"query","name":"with_translations","type":"boolean","required":false,"description":"If true, it should also include course translations"},{"in":"query","name":"page","type":"integer","required":false,"description":"Requested page number result"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Total pages to be returned"},{"in":"query","enum":["id","creation_date","name","code","type","language","course_status","imported_from_content_marketplace","start_date","end_date","category_name","price","has_esignature_enabled"],"name":"sort_attr","type":"string","required":false,"description":"Sort the result by this column. Default value: creation_date"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sort direction. Default value: desc"},{"in":"query","name":"last_update_from","type":"datetime","required":false,"description":"Filter starting from the course last update passed with format yyyy-MM-dd HH:mm:ss"}],"summary":"Returns courses available in the platform","last_modified_date":"2026.02.02","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: extra_filters","1002":"Invalid parameter: extra_filters -> certificate","1003":"Invalid parameter: skill_codes","1004":"Invalid parameter: last_update_from","1010":"Invalid parameter: {X}","1006":"Invalid parameter: updated_by_ids"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}":{"put":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of Course to update"}],"summary":"Update Course General Details","last_modified_date":"2025.12.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Error while processing the requested operation","1001":"Invalid parameter: id","1002":"Invalid parameter: status","1003":"Invalid parameter: category_id","1004":"Invalid parameter: thumbnail_id","1005":"Invalid parameter: cover_id","1006":"Invalid parameter: average_completion_time","1100":"Invalid parameter: average_completion_time - value too small","1101":"Invalid parameter: average_completion_time - value too big","1007":"Invalid parameter: code","1008":"Invalid parameter: name","1009":"Invalid parameter: description","1010":"Invalid parameter: language_code","1011":"Invalid parameter: skills","1012":"Missing parameter: esignature.enabled","1013":"Invalid parameter: esignature.enabled","2022":"Invalid parameter: esignature.enabled - Cannot unsign esignature once signed","1014":"Missing parameter: esignature.title","1015":"Invalid parameter: esignature.title - attribute not a string","1016":"Invalid parameter: esignature.title - attribute longer than 255 characters","1017":"Missing parameter: esignature.description","1018":"Invalid parameter: esignature.description - attribute not a string","1019":"Invalid parameter: esignature.description - attribute longer than 255 characters","1020":"Invalid parameter: esignature.title - attribute sent when enabled is false","1021":"Invalid parameter: esignature.description - attribute sent when enabled is false","1022":"Invalid parameter: time_options.date_begin","1023":"Invalid parameter: time_options.date_end","1024":"Invalid parameter: time_options.soft_deadline","1025":"Invalid parameter: time_options.duration.days","1026":"Invalid parameter: time_options.duration.trigger","1027":"Invalid parameter: time_options.duration.update_existing","1028":"Missing parameter: time_options.duration.days","1029":"Missing parameter: time_options.duration.trigger","1030":"Invalid parameter: rating.mode - parameter passed when enabled is false","1031":"Invalid parameter: social_sharing.mode - parameter passed when enabled is false","1032":"Invalid parameter: social_sharing.networks - parameter passed when enabled is false","1033":"Invalid parameter: social_sharing.share_score - parameter passed when enabled is false","1034":"Invalid parameter: social_sharing.networks - parameter passed when mode is disabled","1035":"Invalid parameter: social_sharing.share_score - parameter passed when mode is disabled","1036":"Invalid parameter: social_sharing.networks - parameter contains invalid value","1037":"Invalid parameter: enrollment_options.enrollment_code - string is too long","1038":"Invalid parameter: enrollment_options.allow_self_session_unenrollment - value not a boolean","1039":"Invalid parameter: enrollment_options.allow_self_session_change - value not a boolean","1040":"Invalid parameter: enrollment_options.allow_self_session_change - value not a boolean","1041":"Invalid parameter: enrollment_options.enrollment_code - SubscriptionCodesApp is not active","2042":"Invalid parameter: enrollment_options.quick_enrollment_enabled","1042":"Invalid parameter: lo_navigation.max_attempts - number cannot be negative","1043":"Invalid parameter: certificate_id - missing certificate","1044":"Invalid parameter: credits - number too small","1045":"Invalid parameter: course_player.background_image.image_id - image with given id does not exist","1046":"Invalid parameter: score_options.initial_score_lo_id - LO does not exist for this course","1047":"Invalid parameter: score_options.initial_score_lo_id - LO cannot have score","1048":"Invalid parameter: score_options.final_score.specific_lo_id - LO cannot have score","1049":"Invalid parameter: certificate_id - certificate id not valid integer","1050":"Invalid parameter: short_description","1051":"Invalid parameter: short_description - The string exceeded 130 characters limit.","1052":"Invalid parameter: vilt_options","1053":"Missing parameter: vilt_options.course_completion","1054":"Invalid parameter: vilt_options.course_completion","1055":"Missing parameter: vilt_options.course_completion.mode","1056":"Invalid parameter: vilt_options.course_completion.mode","1057":"Missing parameter: vilt_options.course_completion.percentage","1058":"Invalid parameter: vilt_options.course_completion.percentage","1059":"Invalid parameter: vilt_options.course_completion.percentage - Integer lesser than 1","1060":"Invalid parameter: vilt_options.course_completion.percentage - Integer greater than 100","1061":"Invalid parameter: vilt_options.course_completion.percentage - Provided when not needed","1062":"Invalid parameter: enrollment_options.course_rsvp - Course is not VILT or RSVP option is not enabled","1063":"Invalid parameter: enrollment_options.course_rsvp - Not valid boolean","1064":"Invalid parameter: certification_id - CertificationApp not active","1095":"Invalid parameter: certification_id - Cannot set legacy certification on a course that belongs to a Certification Learning Plan","1065":"Invalid parameter: enrollment_options.hide_attendees - Course is not VILT or RSVP option is not enabled","1066":"Invalid parameter: catalog_options.demo_material_name - file larger than 4MB","1080":"Invalid parameter: ecommerce_options - EcommerceApp not active","1082":"Invalid parameter: ecommerce_options.affiliate_price - Enabled is false","1083":"Invalid parameter: ecommerce_options.price - Enabled is false","1084":"Invalid parameter: ecommerce_options.price/affiliate_price - Cannot be negative","1085":"Invalid parameter: ecommerce_options.affiliate_price - Cannot be greater than price","1086":"Invalid parameter: ecommerce_options.affiliate_price - ContentPartnersApp not active","1087":"Invalid parameter: ecommerce_options.price - Cannot be bigger than 999999999999","1088":"Invalid parameter: name - Name cannot consist of special characters only","1180":"Missing parameter: ecommerce_options.price","1181":"Invalid parameter: ecommerce_options.price","1182":"Invalid parameter: ecommerce_options.prices.dtc,","1091":"Invalid parameter: skills - Skill property not an array or empty array","1092":"Invalid parameter: skills - Skill property array contains a not-string value or an empty string","1093":"Invalid parameter: skills - Skill property array contains more than 15 unique elements","1094":"Invalid parameter: skills - Skill property codes validation error","1070":"Invalid parameter: catalog_options.self_enrollment - Self enrollment item is not an object","1071":"Invalid parameter: catalog_options.self_enrollment.mode - Mode is not with correct value","1072":"Invalid parameter: catalog_options.self_enrollment.start_date - Setting start date when mode is not timeframe","1073":"Invalid parameter: catalog_options.self_enrollment.end_date - Setting end date when mode is not timeframe","1079":"Invalid parameter: catalog_options.self_enrollment.policy - should be null when mode is disabled","1069":"Invalid parameter: catalog_options.self_enrollment.end_date - End date cannot be before Start date","1075":"Invalid parameter: catalog_options.self_enrollment.policy - Required if mode is not disabled","1076":"Invalid parameter: catalog_options.enrollment_quota.limit - Number cannot be smaller than 0","1078":"Invalid parameter: catalog_options.waiting_list.enabled - should be true when course enrollment policy is pending admin","1068":"Invalid parameter: catalog_options.demo_material_name - not allowed file type","1067":"Invalid parameter: catalog_options.demo_material_name - file does not exist in S3 storage","1120":"Invalid parameter: equivalent_courses - Maximum number of possible equivalences (30) exceeded","1121":"Invalid parameter: equivalent_courses[].course_id Provided id is not numeric","1122":"Invalid parameter: equivalent_courses[].course_id Course with provided id does not exist","1123":"Invalid parameter: equivalent_courses[].course_id Circular equivalence attempt detected","1124":"Invalid parameter: equivalent_courses[].mode Mode value is not one of allowed values: source, target, bidirectional","1125":"Invalid parameter: equivalent_courses[].course_id The course has maximum number of equivalences (30)","1126":"Invalid parameter: equivalent_courses[].course_id Current user has no permission to view pointed course","1127":"Invalid parameter: equivalent_courses Current course has equivalences with courses you cannot manage. Modification not allowed.","1128":"Invalid parameter: equivalent_courses[].course_id Duplicate course_id provided for equivalence.","1110":"Invalid parameter: content_partner Object not well formatted","1111":"Invalid parameter: content_partner.additional_fields Not an array, empty array provided, or array contain a non-object items","1112":"Invalid parameter: content_partner.additional_fields One or more mandatory fields are missing","1113":"Invalid parameter: content_partner.additional_fields Maximum number of additional fields exceeded","1115":"Invalid parameter: {param_name}. The course has no content partner assigned.","1114":"Invalid parameter: content_partner.additional_fields[].id Additional field is missing or not configurable","1116":"Invalid parameter: content_partner.additional_fields Additional fields are set when enabled is false","1117":"Invalid parameter: content_partner.additional_fields[].value Incorrect field value format","1118":"Invalid parameter: content_partner.additional_fields[].value Dropdown value does not exist for this field","1130":"Invalid parameter: header_layout Header Layout must be either null or an object","1131":"Missing parameter: header_layout.mode Header Layout Mode must always be provided","1132":"Invalid parameter: header_layout.mode Header Layout Mode must be one of the following values: \"color\", \"cover_image\", \"basic\"","1133":"Missing parameter: header_layout.color Header Layout Color must be provided when header_layout is \"color\"","1134":"Invalid parameter: header_layout.color Header Layout Color must be a string","1135":"Missing parameter: cover_id Cover Image must be provided when header_layout.mode is \"cover_image\"","1140":"Invalid parameter: course_player.focus_mode Focus Mode must be a boolean or null","1141":"Invalid parameter: course_player.harmony_tutoring Harmony Tutoring must be a boolean or null","2043":"Invalid parameter: enrollment_options.enable_session_unenrolment_on_user_deactivated","2120":"Invalid parameter: enrollment_code The string provided is not alphanumeric type","2121":"Invalid parameter: enrollment_code A course with that same enrollment code already exists","2122":"Invalid parameter: enrollment_code A Subscription Code Set with that same enrollment code already exists","2130":"Invalid parameter: seo_options","2131":"Invalid parameter: seo_options.meta_description","2132":"Invalid parameter: seo_options.meta_description should contain at most 155 characters.","2133":"Missing parameter: seo_options.meta_description","2134":"Invalid parameter: seo_options.redirect_to","2135":"Invalid parameter: seo_options.redirect_to should contain at most 512 characters.","2136":"Invalid parameter: seo_options.redirect_to cannot be the same as the url of the course being edited","2137":"Invalid parameter: seo_options.custom_slug","2138":"Invalid parameter: seo_options.custom_slug should contain at most 255 characters.","2140":"Invalid parameter: certificate","2141":"Missing parameter: certificate.id","2142":"Invalid parameter: certificate.id","2143":"Invalid parameter: certificate.additional_certificates","2144":"Missing parameter: certificate.additional_certificates[].sequence","2145":"Invalid parameter: certificate.additional_certificates[].sequence","2146":"Missing parameter: certificate.additional_certificates[].certificate_id","2147":"Invalid parameter: certificate.additional_certificates[].certificate_id","2148":"Missing parameter: certificate.additional_certificates[].association_entity","2149":"Invalid parameter: certificate.additional_certificates[].association_entity","2150":"Missing parameter: certificate.additional_certificates[].association_entity.id","2151":"Invalid parameter: certificate.additional_certificates[].association_entity.id","2152":"Missing parameter: certificate.additional_certificates[].association_entity.type","2153":"Invalid parameter: certificate.additional_certificates[].association_entity.type","2154":"Invalid parameter: certificate.additional_certificates[]","2155":"Invalid parameter: certificate.additional_certificate_options","2156":"Invalid parameter: certificate.additional_certificate_options.enable_multiple_certificates_generation","2157":"Missing parameter: certificate.additional_certificate_options.enable_multiple_certificates_generation","2158":"Invalid parameter: certificate.additional_certificate_options.certificates_to_generate","2159":"Missing parameter: certificate.additional_certificate_options.certificates_to_generate","3000":"Invalid parameter: multilanguage_codes","3001":"Missing required parameter: language_code","3002":"Missing required parameter: multilanguage_codes","4000":"Invalid course translation format","4001":"Invalid course translation - missing default language","4002":"Invalid course translation - language code is not allowed","4003":"Missing required parameter: course_information_translations"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the course"}],"summary":"View a Course info","last_modified_date":"2025.12.16","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesViewResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Course not found","1001":"Invalid parameter: id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/seats":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/seats","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter results by: username, first name or last name of the Power User"},{"in":"query","enum":["id","username","firstname","lastname","used_seats","purchased_seats","extra_seats","total_seats"],"name":"sort_attr","type":"string","required":false,"description":"Order the result by column. Default: id"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Order directional (ascending, descending). Default: asc"},{"in":"query","name":"page","type":"integer","required":false,"description":"The data page to display. Default: 0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of records to display. Default: Platform setting of displayed records"},{"in":"query","name":"seats","type":"object","required":false,"description":"Filter results by purchased seats"}],"summary":"Get a list of course seats","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesSeatsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"The provided course wasn't for sale."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/seats/{user_id}":{"post":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/seats/{user_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesAddSeatsSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the Power User that manages this course"}],"summary":"Assign extra seats to a Power User who manages a course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesAddSeatsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"The provided course wasn't for sale."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/seats/{user_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesUpdateSeatsSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the Power User that manages this course"}],"summary":"Update seats of a Power User who manages a course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesUpdateSeatsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"The provided course wasn't for sale.","1003":"You cannot remove extra seats, that are already assigned to users","1004":"extra_seats should be less than 2147483647"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/enrollable_users":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/enrollable_users","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the course"},{"in":"query","name":"page","type":"integer","required":false,"description":"Requested page number result"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Total pages to be returned"},{"in":"query","enum":["user_id","username","first_name","last_name","email","ai_suggested"],"name":"sort_attr","type":"string","required":false,"description":"Sort the result by this column. Default value: ai_suggested"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sort direction. Default value: desc"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in first name, last name, email and username of the users"},{"in":"query","name":"skip_recommender","type":"boolean","required":false,"description":"0 or 1, if set to 1 then avoid recommender calculation for better performances. Default = 0"}],"summary":"Get list of users that could be enrolled in a given course","last_modified_date":"2022.05.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesEnrollableUsersResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/sign":{"post":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/sign","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesSignSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the course"}],"summary":"Sign to a course","last_modified_date":"","description":"Only available when EsignatureApp is on","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesSignResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'identifier'","1002":"Missing parameter otp or recovery_code","1020":"Missing parameter otp","1003":"AuthenticatorApp not paired","1004":"Invalid OTP or recovery_code","1010":"Invalid parameter: identifier","1011":"Invalid parameter: otp","1019":"Invalid parameter: recovery_code","1012":"You are not enrolled in this course.","1013":"Your status does not allow access at the moment","1014":"Course is not marked as e-signature","1015":"Invalid e-signature state","1016":"The course does not exist","1017":"Error while calling verifications API"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/duplicate":{"post":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/duplicate","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesDuplicateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"Internal ID of the course"}],"summary":"Duplicate e-learning course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesDuplicateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Operation failure"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/catalogs":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/catalogs","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 20)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","enum":["action","timestamp"],"name":"sort_column","type":"string","required":false,"description":"The name of the sortable field"},{"in":"query","enum":["asc","desc"],"name":"sort_direction","type":"string","required":false,"description":"The order for which you want to sort the results"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A part of name used for search"}],"summary":"Returns catalogs related to the given course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetCatalogsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid or missing parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/lp":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/lp","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 20)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field: &#039;path_name&#039;, &#039;path_descr&#039;, or &#039;path_code&#039;"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"The order for which you want to sort the results"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A part of name used for search"}],"summary":"Returns learning plans related to the given course","last_modified_date":"2026.04.22","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetLearningPlansResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid or missing parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/lp/{lp_id}":{"delete":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/lp/{lp_id}","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"path","name":"lp_id","type":"integer","required":true,"description":"ID of the existing learning plan"}],"summary":"Remove learning plan from a course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesDeleteLearningPlansResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"The association between this course and this learning plan can't be removed","1003":"Course not associated to current user","1004":"Cannot remove the last remaining mandatory course association from learning plan"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/lp":{"post":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/lp","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesPostAssignLearningPlansSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the existing course"}],"summary":"Assigns learning plan from a course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesPostAssignLearningPlansResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}","1003":"Learning plan {X} not found","1004":"Learning plan <{lp_id}> already associated","1005":"You cannot assign the course to the learning plans: {learningplan_ID}","1006":"You can not assign courses containing training material from the Content marketplace to learning plans that are for sale","1007":"Missing parameter: {X}","1008":"Course limit exceeded for certification learning plans: {learningplan_ID}","1009":"Cannot add courses to certification learning plan(s): a legacy certification is already associated. Conflicting course(s): {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/lp/candidates":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/lp/candidates","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 20)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"The order for which you want to sort the results"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A part of name used for search"}],"summary":"Returns all the learning plans associated or associable to a specific course","last_modified_date":"2026.04.20","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetLearningPlansCandidatesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid or missing parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/channels":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/channels","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 10)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","enum":["name","description"],"name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A part of name used for search"}],"summary":"Returns channels associated to the given course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetChannelsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid or missing parameter","1003":"Course not found","1004":"No permission to see channels"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/channel/{channel_id}":{"delete":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/channel/{channel_id}","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"channel_id","type":"integer","required":true,"description":"ID of the channel"}],"summary":"Remove association between course and channel","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesDeleteChannelAssociationResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/channels":{"post":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/channels","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesPostChannelsSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the existing course"}],"summary":"Assigns channels to a course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesPostChannelsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid or missing parameter","1006":"Course not associated to current user","1007":"Course not found","1008":"One or more Channels were not found","1009":"One or more Channels are already associated","1010":"One or more Channels are predefined","1011":"Not allowed to associate channels"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/channel/candidates":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/channel/candidates","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 20)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","enum":["action","timestamp"],"name":"sort_column","type":"string","required":false,"description":"The name of the sortable field"},{"in":"query","enum":["asc","desc"],"name":"sort_direction","type":"string","required":false,"description":"The order for which you want to sort the results"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A part of name or description used for search"}],"summary":"Returns all the Channels associated or associable to a specific course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetChannelsCandidatesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid or missing parameter","1003":"Course not found","1004":"No permission to see channels"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/enrollments":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/enrollments","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 10)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","enum":["username","email","first_name","last_name","level","enrollment_date","active_from","active_until","status","score_given","date_complete"],"name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field. (default: enrollment_date)"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending. (default: desc)"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A part of name, email or username used for search. The search is case insensitive."},{"in":"query","name":"skip_recalculation","type":"boolean","required":false,"description":"If set skip recalculation of the enrollment score"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"level","type":"array","required":false,"description":"ID of the user level enrolled in the course. Possible values : Student = 3, Tutor = 4, Instructor = 6"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"status","type":"array","required":false,"description":"ID of the user&#039;s registration status to the course. Possible values : Waiting = -2, Subscription to confirm = -1, Subscribed = 0, In progress = 1, Completed = 2, Suspended = 3, Overbooking = 4"},{"in":"query","name":"user_status","type":"integer","required":false,"description":"ID of the user&#039;s status. Possible values : Active = 1, Deactiveted = 0, All = leave empty."},{"in":"query","enum":["show"],"name":"show_enrollment_fields","type":"string","required":false,"description":"If set display enrollments field"},{"in":"query","name":"notEnrolledInSessions","type":"integer","required":false,"description":"If set to 1: filter users not enrolled in any sessions, -1: filter users enrolled in any sessions, 0: no filter"},{"in":"query","name":"not_enrolled_in_sessions_as_waiting_users","type":"integer","required":false,"description":"If set to 1 then filtering by waiting status will also retrieve users not assignet to any session (if the course is ILT, this parameter is ignored for e-learning courses). Set to 0 to ignore this feature."},{"in":"query","name":"completed_at_start","type":"datetime","required":false,"description":"UTC lower bound (inclusive) for an enrollment completion date to filter by"},{"in":"query","name":"completed_at_end","type":"datetime","required":false,"description":"UTC upper bound (inclusive) for an enrollment completion date to filter by"},{"in":"query","name":"branch_id","type":"integer","required":false,"description":"Filtering by branch ID"},{"in":"query","name":"group_id","type":"string","required":false,"description":"Filtering by group ID"},{"in":"query","name":"descendant_branch","type":"integer","required":false,"description":"Branches with children or not. When &quot;1&quot; include all descendant branch, default &quot;0&quot;"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"assignment_type","type":"array","required":false,"description":"Enrollment assignment type. Can be passed only when this attribute is configured in the platform advanced settings. The possible values are &quot;null&quot;, &quot;mandatory&quot;, &quot;required&quot;, &quot;recommended&quot; and &quot;optional&quot;, but to be accepted they must be enabled in the settings. The null value can be used to get enrollments with assignment type not set"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"extra_fields","type":"array","required":false,"description":"Additional data that can optionally be requested in output. Possible values: branches. NOTE: the calculations required for additional data may slow down the API performance"},{"in":"query","enum":["poweruser"],"name":"role","type":"string","required":false,"description":"A flag to force a role for the caller when it has multiple roles (e.g. Power User and Instructor)."}],"summary":"Returns enrollments associated to the given course","last_modified_date":"2025.05.22","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetEnrollmentsResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/batch/status/{status_id}":{"put":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/batch/status/{status_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesPutBatchStatusSchema"}},{"in":"path","name":"status_id","type":"integer","required":true,"description":"ID of the status (0 = Under maintenance, 2 = published)"}],"summary":"Batch Update course's status","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesPutBatchStatusResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/batch/thumbnail/{thumbnail_id}":{"put":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/batch/thumbnail/{thumbnail_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesPutBatchThumbnailSchema"}},{"in":"path","name":"thumbnail_id","type":"integer","required":true,"description":"ID of the thumbnail"}],"summary":"Batch Update course's thumbnail","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesPutBatchThumbnailResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/sessions":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/sessions","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the existing course"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 10)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","enum":["code","name","date_begin","date_end","hours","events","instructors","waiting","enrolled"],"name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field. (default: date_begin)"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending. (default: desc)"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A fulltext search to filter the results for. Will search by the name, code of the session"},{"in":"query","name":"date_begin","type":"string","required":false,"description":"Session begin date filtering (format: YYYY-MM-DD, YYYY-MM-DD hh:mm:ss)"},{"in":"query","name":"date_end","type":"string","required":false,"description":"Session end date filtering (format: YYYY-MM-DD, YYYY-MM-DD hh:mm:ss)"},{"in":"query","name":"extra_filters","type":"object","required":false,"description":"Additional optional filters to be applied over the returned result. Example: {extra_filters:{without_events:{criteria:enum(equal_to),value:integer},with_user_waiting:{criteria:enum(equal_to),value:integer},without_user_enrolled:{criteria:enum(equal_to),value:integer},without_instructors:{criteria:enum(equal_to),value:integer}}}"},{"in":"query","name":"not_enrolled","type":"boolean","required":false,"description":"A flag to filter the results for. Will search for all the sessions to which this learner is not enrolled"},{"in":"query","enum":["instructor"],"name":"role","type":"string","required":false,"description":"A flag to force a role for the caller when it has multiple roles (e.g. Power User and Instructor)"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"attendance_types","type":"array","required":false,"description":"Session types to filter the results for (onsite, online, flexible, blended). Will search for all the sessions with events corresponding to these types."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"instructor_ids","type":"array","required":false,"description":"Instructor ids to filter the results for. Will search for all the sessions to which these instructors are linked.(Provide only one of the parameters between instructor_id and instructor_ids)"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"learner_ids","type":"array","required":false,"description":"Learner ids to filter the results for. Will search for all the sessions to which these learners are linked.(Provide only one of the parameters between learner_id and learner_ids)"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"location_ids","type":"array","required":false,"description":"Locations ids to filter the results for. Will search for all the sessions to which these locations are linked."}],"summary":"Returns sessions associated to the given course","last_modified_date":"2022.12.02","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesListSessionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter","1003":"Course not found","1004":"Course type 'elearning' doesn't have sessions","1005":"Session end date must be equal or greater than session begin date"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/sessions","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesNewSessionSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"Internal ID of the course"}],"summary":"Create a session in a course","last_modified_date":"2025.06.04","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesNewSessionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}","1003":"Course not found","1004":"Missing required parameter: {X}","1005":"Invalid Mandatory Additional Field '{X}'","1006":"Invalid Additional Field value","1007":"Min enroll cannot be less than zero or greater than Max enroll","1008":"Max enroll must be greater than zero","1009":"Max enroll cannot be less than the total number of user enrolled","1010":"Enrollment deadline and custom deadline cannot be defined together","1011":"Max enrollable instructor quota reached","1012":"This session is managed through a third party application","1013":"Invalid parameter for the evaluation type","1014":"Minimum attendance dates cannot be less than or equal to zero"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/enrollments":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/enrollments","parameters":[{"in":"query","collectionFormat":"brackets","items":{"type":"int"},"name":"user_id","type":"array","required":false,"description":"Filter on users IDs"},{"in":"query","collectionFormat":"brackets","items":{"type":"int"},"name":"course_id","type":"array","required":false,"description":"Filter on courses IDs"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"course_uid","type":"array","required":false,"description":"Filter on courses UIDs"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"course_code","type":"array","required":false,"description":"Filter on courses codes"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"course_type","type":"array","required":false,"description":"Filter on course types. Possible values: elearning, classroom"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"enrollment_level","type":"array","required":false,"description":"Filter on enrollment levels. Possible values: student, instructor, tutor"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"enrollment_status","type":"array","required":false,"description":"Filter on enrollment statuses. Possible values: enrolled, in_progress, completed, subscription_to_confirm, waiting, suspended, overbooking"},{"in":"query","name":"enrollment_validity_from","type":"date","required":false,"description":"Filter on enrollment validity period, selecting record having validity after passed date"},{"in":"query","name":"enrollment_validity_to","type":"date","required":false,"description":"Filter on enrollment validity period, selecting record having validity before passed date"},{"in":"query","name":"enrollment_updated_from","type":"datetime","required":false,"description":"Filter on last updating date, selecting record after passed date"},{"in":"query","name":"enrollment_updated_to","type":"datetime","required":false,"description":"Filter on last updating date, selecting record before passed date"},{"in":"query","name":"exclude_courses_in_lp","type":"boolean","required":false,"description":"Excludes courses that belong to a learning plan. Default=false"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"extra_fields","type":"array","required":false,"description":"Additional data that can optionally be requested in output. Possible values: enrollment_time_spent. NOTE: the calculations required for additional data may slow down the API performance"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default=0"},{"in":"query","name":"page","type":"integer","required":false,"description":"Requested page number result (starting from 1)"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of records in a single page (from 1 to 200)"},{"in":"query","enum":["enrollment_created_at","course_begin_date","course_end_date","enrollment_validity_begin_date","enrollment_validity_end_date","enrollment_completion_date"],"name":"sort_attr","type":"string","required":false,"description":"Sort the result by this column. Default value: enrollment_created_at"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sort direction. Default value: desc"},{"in":"query","name":"completed_at_start","type":"datetime","required":false,"description":"UTC lower bound (inclusive) for an enrollment completion date to filter by"},{"in":"query","name":"completed_at_end","type":"datetime","required":false,"description":"UTC upper bound (inclusive) for an enrollment completion date to filter by"}],"summary":"Retrieves courses enrollments","last_modified_date":"2025.05.22","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/additionalfields/batch":{"post":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/additionalfields/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesPostAdditionalFieldsSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the course"}],"summary":"Stores courses additional fields values (batch)","last_modified_date":"2024.09.09","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesPostAdditionalFieldsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Missing parameter","1003":"Error while processing the requested operation"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/los/assignments":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/los/assignments","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"The ID of the course"},{"in":"query","name":"page","type":"integer","required":false,"description":"page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"maximum number of results per page. The default size is defined in Advanced Settings page (set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."}],"summary":"Get All Assignment Training Materials For A Given Course","last_modified_date":"","description":"This endpoint will return all the assignments training materials in a given course. This endpoint is available to Superadmins only.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Generic error","1002":"Invalid Course ID","1010":"The course does not exist","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/los/assignments/{assignment_id}/attempts":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/los/assignments/{assignment_id}/attempts","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"The ID of the course"},{"in":"path","name":"assignment_id","type":"integer","required":true,"description":"The ID of the assignment training material"},{"in":"query","enum":["pending","accepted","rejected"],"name":"status","type":"string","required":false,"description":"The evaluation status of the attempts"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. 1 is enabled, 0 disabled. Default is 0."}],"summary":"Get Assignment Files Links By Training Material","last_modified_date":"","description":"This endpoint will retrieve the urls of the assignments uploaded by users for a single assignment training material. This endpoint is available to Superadmins only.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsResponse"}},"400":{"description":"General Error","error_codes":{"1021":"The {status} parameter has an invalid value. Accepted values: pending, accepted, rejected","1199":"DB Errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/tm":{"put":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/tm","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesUpdateTrainingMaterialSettingsSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"course identifier"}],"summary":"Update one or more Training Materials in the given course","last_modified_date":"2023.11.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesUpdateTrainingMaterialSettingsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Missing parameter: items","1001":"Invalid parameter: items","1002":"Maximum number of records exceeded: {max_request}","1004":"Missing parameter: tm_id","1005":"Invalid parameter: tm_id","1006":"Invalid parameter: visible","1007":"Invalid parameter: publish_from","1008":"Invalid parameter: publish_to","1009":"Invalid parameter: self_prerequisite","1010":"Invalid parameter: is_terminator","1011":"Invalid parameter: width","1012":"Invalid parameter: height","1013":"Invalid parameter: launch_mode","1014":"Invalid parameter: folder_id","1015":"Invalid parameter: course_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{course_id}/tests/{test_id}/attempts":{"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{course_id}/tests/{test_id}/attempts","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"test_id","type":"integer","required":true,"description":"ID of the Training Material Test"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search phrase for username, first name and last name columns"},{"in":"query","name":"question_ids","type":"array","required":false,"description":"Array of applied questions filter"},{"in":"query","enum":["true","false"],"name":"last_attempts_only","type":"string","required":false,"description":"Whether to filter results only returning last attempts for each user. (default: false)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 50)"},{"in":"query","enum":["idst","username","first_name","last_name"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field. (default: idst)"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction. (default: asc)"}],"summary":"Retrieve all the attempts made on a given test","last_modified_date":"2023-05-16","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesTestAttemptsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/archive":{"post":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/archive","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesArchiveSchema"}}],"summary":"Start archive process for courses","last_modified_date":"2025.11.03","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesArchiveResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter: items","1002":"Invalid parameter: options.upload_training_materials","1103":"Max number of items exceeded (20)","1201":"One or more courses do not exist","1202":"One or more courses are part of a learning plan","1203":"One or more courses are part of an automatic group","1301":"Course already in archive process"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/courses/{id}/translations":{"patch":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/translations","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesUpdateCourseTranslationsSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of Course to update"}],"summary":"Update Course Translations in append mode","last_modified_date":"2026.02.26","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesUpdateCourseTranslationsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Error while processing the requested operation","1001":"Invalid parameter: id","4000":"Invalid course translation format","4002":"Invalid course translation - language code is not allowed","4003":"Missing required parameter: course_information_translations"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/translations","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the course"}],"summary":"List the translations of the given course","last_modified_date":"2026.03.03","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesListCourseTranslationsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Courses"],"operationId":"Courses./course/v1/courses/{id}/translations","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseCoursesDeleteCourseTranslationsSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the course"}],"summary":"Delete course translations by language codes","last_modified_date":"2026.02.26","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseCoursesDeleteCourseTranslationsResponse"}},"400":{"description":"General Error","error_codes":{"4000":"Bad Request - Invalid field lang_codes (not an array or contains non-string elements)","4001":"Bad Request - Cannot delete the default language translation","4002":"Bad Request - Language code is not allowed (non-existing)"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/events/{event_id}":{"get":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}","parameters":[{"in":"path","name":"event_id","type":"integer","required":true,"description":"ID of the existing event"}],"summary":"Get an event","last_modified_date":"2022.12.06","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsGetEventResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseEventsEditEventSchema"}},{"in":"path","name":"event_id","type":"integer","required":true,"description":"ID of the event"}],"summary":"Edit an event","last_modified_date":"2022.06.12","description":"This endpoint overwrites event data based on the payload passed. All optional fields not passed in the payload will be converted to default empty values and will be overwritten","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsEditEventResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}","parameters":[{"in":"path","name":"event_id","type":"integer","required":true,"description":"The ID of the event to delete"}],"summary":"Delete an event","last_modified_date":"2022.04.07","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsDeleteEventResponse"}},"400":{"description":"General Error","error_codes":{"400":"Missing mandatory params","401":"User not authenticated","403":"User is NU or PU","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/events/{event_id}/attendance":{"get":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/attendance","parameters":[{"in":"path","name":"event_id","type":"integer","required":true,"description":"ID of the existing event"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 10)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","enum":["username","email","first_name","last_name","time"],"name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field. (default: username)"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending. (default: desc)"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A part of name, email or username used for search. The search is case insensitive"},{"in":"query","name":"status","type":"integer","required":false,"description":"Additional optional filters: 0 = absent, 1 = present, -1 = not set"},{"in":"query","name":"time_from","type":"integer","required":false,"description":"Additional optional filters: attendance time in minutes to filter from"},{"in":"query","name":"time_to","type":"integer","required":false,"description":"Additional optional filters: attendance time in minutes to filter to"},{"in":"query","enum":["instructor"],"name":"role","type":"string","required":false,"description":"A flag to force a role for the caller when it has multiple roles (e.g. Power User and Instructor)."}],"summary":"Returns the attendance of a given event","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsListAttendanceResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/attendance","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseEventsEditAttendanceSchema"}},{"in":"path","name":"event_id","type":"integer","required":true,"description":"ID of the event"}],"summary":"Edit an attendance","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsEditAttendanceResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/events/{event_id}/duplicate":{"post":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/duplicate","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseEventsDuplicateEventSchema"}},{"in":"path","name":"event_id","type":"integer","required":true,"description":"ID of the existing event"}],"summary":"Duplicate an event","last_modified_date":"2022.04.07","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsDuplicateEventResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/events/{event_id}/sync":{"post":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/sync","parameters":[{"in":"path","name":"event_id","type":"integer","required":true,"description":"The ID of the event to sync"}],"summary":"Sync an event","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsSyncEventResponse"}},"400":{"description":"General Error","error_codes":{"400":"Missing mandatory params","401":"User not authenticated","403":"User is NU or PU","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/events/{event_id}/recording":{"post":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/recording","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseEventsUploadRecordingSchema"}},{"in":"path","name":"event_id","type":"integer","required":true,"description":"The id of the event"}],"summary":"Submit a recording for an event","last_modified_date":"2026.01.04","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsUploadRecordingResponse"}},"400":{"description":"General Error","error_codes":{"400":"Missing mandatory params","401":"User not authenticated","403":"Forbidden","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/recording","parameters":[{"in":"path","name":"event_id","type":"integer","required":true,"description":"The id of the event"}],"summary":"Delete a recording for an event","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsDeleteRecordingResponse"}},"400":{"description":"General Error","error_codes":{"400":"Missing mandatory params","401":"User not authenticated","403":"Forbidden","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/recording","parameters":[{"in":"path","name":"event_id","type":"integer","required":true,"description":"The id of the event"}],"summary":"Check the status of a recording for an event","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsGetRecordingStatusResponse"}},"400":{"description":"General Error","error_codes":{"400":"Missing mandatory params","401":"User not authenticated","403":"Forbidden","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/events/{event_id}/watch_recording":{"get":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/watch_recording","parameters":[{"in":"path","name":"event_id","type":"integer","required":true,"description":"The id of the event"}],"summary":"Get the recording of an event","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsGetRecordingResponse"}},"400":{"description":"General Error","error_codes":{"1000":"The session with ID {0} does not exist","1001":"The session with ID {0} and event {1} was not found","1002":"The session with ID {0} and event {1} has no uploaded file or video link","1003":"This information is not available yet as the session with ID {0} and event {1} is not completed","1004":"User with id \"{X}\" is not enrolled in session with id \"{Y}\"."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/events/{event_id}/join_webtool":{"get":{"tags":["Events"],"operationId":"Events./course/v1/events/{event_id}/join_webtool","parameters":[{"in":"path","name":"event_id","type":"integer","required":true,"description":"The id of the event"},{"in":"query","name":"forced_evaluation","type":"boolean","required":false,"description":"Force the session date evaluation (For postponed saving systems ex. AdobeConnectV2)"},{"in":"query","name":"user_id","type":"integer","required":false,"description":"A fixed user id for which you want to trigger the webinar join"}],"summary":"Joining or starting a webinar event","last_modified_date":"2023.06.05","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseEventsGetJoinUrlResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Something is missing, please set a video conference tool","1001":"User is not enrolled in this session event"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/instructors/{instructor_id}/freebusy":{"post":{"tags":["Instructors"],"operationId":"Instructors./course/v1/instructors/{instructor_id}/freebusy","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseInstructorsFreeBusySchema"}},{"in":"path","name":"instructor_id","type":"integer","required":true,"description":"ID of an existing instructor"}],"summary":"Checks instructor availability given a session and a time-frame","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseInstructorsFreeBusyResponse"}},"400":{"description":"General Error","error_codes":{"404":"Invalid instructor id","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/instructors/add":{"post":{"tags":["Instructors"],"operationId":"Instructors./course/v1/instructors/add","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseInstructorsBatchAssignSchema"}}],"summary":"Assign instructors to sessions or events","last_modified_date":"2026.03.13","description":"This endpoint will add (default) or replace existing session or event instructors with the ones passed in the payload.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseInstructorsBatchAssignResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/instructors/importer_fields":{"get":{"tags":["Instructors"],"operationId":"Instructors./course/v1/instructors/importer_fields","parameters":[],"summary":"Returns list of mappable fields for the data importer","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseInstructorsImporterFieldsInstructorResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/instructors":{"get":{"tags":["Instructors"],"operationId":"Instructors./course/v1/instructors","parameters":[{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"type_ids","type":"array","required":true,"description":""},{"in":"query","enum":["course","session","event"],"name":"type","type":"string","required":true,"description":""},{"in":"query","name":"events_only","type":"boolean","required":false,"description":"If true returns only the events instructors, excluding the session&#039;s instructors, Default = false"},{"in":"query","name":"filter_events_end_before_date_utc","type":"datetime","required":false,"description":"Filter all events ending before this filter date. This filter does not affect session instructors, only event instructors."},{"in":"query","name":"filter_events_end_after_date_utc","type":"datetime","required":false,"description":"Filter all events ending after this filter date. This filter does not affect session instructors, only event instructors."},{"in":"query","enum":["user_id"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - user_id."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction. Default - asc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. The default size is defined in Advanced Settings page (Set the amount of elements you want to display in each page)"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default=0"}],"summary":"It returns the instructors info related to sessions and/or events","last_modified_date":"2025.05.21","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseInstructorsInstructorsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Missing parameter","1003":"Error when parsing data"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/instructors/email":{"post":{"tags":["Instructors"],"operationId":"Instructors./course/v1/instructors/email","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseInstructorsSendEmailToInstructorsSchema"}}],"summary":"Email relevant instructors about the given course, sessions or events","last_modified_date":"2025.05.21","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseInstructorsSendEmailToInstructorsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Missing parameter","1003":"Invalid email. Please insert an email address that complies with the email security settings criteria configured in Domain Management"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/instructors/remove":{"put":{"tags":["Instructors"],"operationId":"Instructors./course/v1/instructors/remove","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseInstructorsBatchRemoveInstructorsSchema"}}],"summary":"Delete instructors from a session/event","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseInstructorsBatchRemoveInstructorsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: {parameter_name}\"","1002":"Missing parameter: {parameter_name}\"","1003":"Session not found","1004":"Event not found","1005":"User not found","1006":"Max number of entities exceeded (200)"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/sessions/{session_id}":{"put":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/{session_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseSessionsEditSessionSchema"}},{"in":"path","name":"session_id","type":"integer","required":true,"description":"Internal ID of the session"}],"summary":"Edit a session","last_modified_date":"2025.06.04","description":"This endpoint overwrites session data based on the payload passed. All optional fields not passed in the payload will be converted to default empty values and will be overwritten.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsEditSessionResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Course not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/{session_id}","parameters":[{"in":"path","name":"session_id","type":"integer","required":true,"description":"The ID of the event to delete"}],"summary":"Delete a session","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsDeleteSessionResponse"}},"400":{"description":"General Error","error_codes":{"400":"Missing mandatory params","401":"User not authenticated","403":"User is NU or PU","404":"Session not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/{session_id}","parameters":[{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of the existing session"}],"summary":"Get a session","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsGetSessionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"The session does not exist"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/sessions/{session_id}/events":{"get":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/{session_id}/events","parameters":[{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of the existing session"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 10)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","enum":["name","date","time_begin","hours","instructors","attendance","location","classroom"],"name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field. (default: date)"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending. (default: desc)"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A fulltext search to filter the results for. It will search by the name of the events."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"types","type":"array","required":false,"description":"Filter and return only this types of entities: possible values for each element in the array: venue, tool, both"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"instructor_ids","type":"array","required":false,"description":"An array of instructor ids to filter the results for. It will search for all the events to which at least one of these instructors is assigned."},{"in":"query","name":"date_begin","type":"datetime","required":false,"description":"Event start date filtering (format: YYYY-MM-DD HH:mm:ss)"},{"in":"query","name":"date_end","type":"datetime","required":false,"description":"Event end date filtering (format: YYYY-MM-DD HH:mm:ss)"},{"in":"query","name":"extra_filters","type":"object","required":false,"description":"Additional optional filters to be applied over the returned result. Example: {extra_filters:{without_attendance:{criteria:enum(equal_to),value:integer},without_event_instructors:{criteria:enum(equal_to),value:integer},with_synchronization_warning:{criteria:enum(equal_to),value:integer(0|1)}}} (with_synchronization_warning should return events with webinar_tool_sync_failed = true OR external_calendar_sync_failed = true (if the toggle is ON and Advanced Setting is ON))"},{"in":"query","name":"location_id","type":"integer","required":false,"description":"A location id to filter the results for. It will search for all the events to which this location is linked."},{"in":"query","name":"video_conference_tool","type":"string","required":false,"description":"A video conference tool to filter the results for. It will search for all the events to which this video conference tool is linked."},{"in":"query","enum":["instructor"],"name":"role","type":"string","required":false,"description":"A flag to force a role for the caller when it has multiple roles (e.g. Power User and Instructor)."}],"summary":"Returns events list for the session","last_modified_date":"2022.07.22","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsListEventsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Invalid or missing parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/{session_id}/events","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseSessionsCreateEventSchema"}},{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of the event"}],"summary":"Create a new event in the session","last_modified_date":"2026.04.17","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsCreateEventResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Event not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/sessions/{session_id}/enrollments":{"get":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/{session_id}/enrollments","parameters":[{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of the existing session"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The number of requested records (default: 10)"},{"in":"query","name":"page","type":"integer","required":false,"description":"The requested page (default: 1)"},{"in":"query","enum":["username","email","first_name","last_name","enrollment_date","completion_date","status","evaluation_date","evaluation"],"name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field. (default: enrollment_date)"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending. (default: desc)"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A part of name, email or username used for search. The search is case insensitive."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"status","type":"array","required":false,"description":"ID of the user&#039;s registration status to the session. Possible values : Waiting = -2, Subscription to confirm = -1, Subscribed = 0, In progress = 1, Completed = 2, Suspended = 3"},{"in":"query","name":"evaluation_status","type":"integer","required":false,"description":"Additional optional filters: 1 = only evaluated users, 0 = users without evaluation."},{"in":"query","name":"completion","type":"integer","required":false,"description":"Additional optional filters: 1 = users who have completed the session, 0 = users who have not completed the session."},{"in":"query","enum":["show"],"name":"show_enrollment_fields","type":"string","required":false,"description":"Option to show enrollment additional fields."},{"in":"query","enum":["instructor"],"name":"role","type":"string","required":false,"description":"A flag to force a role for the caller when it has multiple roles (e.g. Power User and Instructor)."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"rsvp_answers","type":"array","required":false,"description":"RSVP answers received from the External Calendar. This function is available only when the Advanced Settings → ILT → RSVP is ON and RSVP sync is enabled (at course or session level). (Possible values: 0=awaiting, 1=no, 2=maybe, 3=yes)"},{"in":"query","enum":["one_event","all_events"],"name":"rsvp_option","type":"string","required":false,"description":"Option to filter RSVP answers received from the External Calendar. This function is available only when the Advanced Settings → ILT → RSVP is ON and RSVP sync is enabled (at course or session level). This parameter shall be used together with rsvp_answers parameter, or it will be ignored. If not passed together with rsvp_answers, the default value is one_event."},{"in":"query","name":"branch_id","type":"integer","required":false,"description":"Filtering by branch ID"},{"in":"query","name":"group_id","type":"string","required":false,"description":"Filtering by group ID"},{"in":"query","enum":["true","false"],"name":"descendant_branch","type":"string","required":false,"description":"Branches with children or not. When true include all descendant branch, default false"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"extra_fields","type":"array","required":false,"description":"Additional data that can optionally be requested in output. Possible values: branches. NOTE: the calculations required for additional data may slow down the API performance"}],"summary":"Returns enrollments associated to the given session","last_modified_date":"2024.10.01","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsListSessionEnrollmentsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/sessions/{session_id}/evaluate":{"put":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/{session_id}/evaluate","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseSessionsEvaluateSessionSchema"}},{"in":"path","name":"session_id","type":"integer","required":true,"description":"Internal ID of the session"}],"summary":"Evaluate a session","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsEvaluateSessionResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Session not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/sessions/{session_id}/duplicate":{"post":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/{session_id}/duplicate","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseSessionsDuplicateSessionSchema"}},{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of the existing session"}],"summary":"Duplicate a session","last_modified_date":"2025.04.23","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsDuplicateSessionResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid or missing parameter","404":"Session not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/sessions/importer_fields":{"get":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/importer_fields","parameters":[],"summary":"Returns list of mappable fields for the data importer","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsImporterFieldsSessionResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/sessions/batch":{"post":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsSchema"}}],"summary":"Batch import of ILT Sessions","last_modified_date":"","description":"This endpoint is used to import multiple ILT sessions. When updating an existing session(s) you must pass the session id. When updating an existing session(s) all data not passed in the call related to the entity will be cleared. The maximum number of items that this api can handle, per call, is 100.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/sessions/ilt":{"get":{"tags":["Sessions"],"operationId":"Sessions./course/v1/sessions/ilt","parameters":[{"in":"query","name":"last_update","type":"string","required":false,"description":"Last update of vilt session."},{"in":"query","name":"date_begin","type":"string","required":false,"description":"Start date of vilt session."},{"in":"query","name":"date_end","type":"string","required":false,"description":"End date of vilt session."},{"in":"query","name":"page","type":"integer","required":false,"description":"The page number. Default value: 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The items per page. Default value: 10"}],"summary":"Return ilt sessions","last_modified_date":"2025.03.18","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseSessionsListAllIltSessionsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/thumbnails/{id}":{"delete":{"tags":["Thumbnails"],"operationId":"Thumbnails./course/v1/thumbnails/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the thumbnail"}],"summary":"Delete a thumbnail","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseThumbnailsDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Error while processing the requested operation"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Thumbnails"],"operationId":"Thumbnails./course/v1/thumbnails/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseThumbnailsUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the thumbnail"}],"summary":"Update thumbnail information","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseThumbnailsUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameter","1005":"Operation failed"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Thumbnails"],"operationId":"Thumbnails./course/v1/thumbnails/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of image from type courselogo, course_cover, playerbg, course_original_image, lo_image"},{"in":"query","name":"refresh_metadata","type":"boolean","required":false,"description":"When provided, fetches live metadata from the original image (filesize, dimensions, etc)"}],"summary":"View a Course Thumbnail.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseThumbnailsViewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/thumbnails":{"get":{"tags":["Thumbnails"],"operationId":"Thumbnails./course/v1/thumbnails","parameters":[{"in":"query","name":"current_image_id","type":"integer","required":false,"description":"Passing the parameter should cause the API to return the asset with this ID always at first position (index=0)"},{"in":"query","name":"filters","type":"object","required":false,"description":"Filters to apply to the list of thumbnails"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A fulltext search to filter the results for. Will search in the thumbnail title or author name"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id."},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page to return, default 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page, default 200, if value is -1 -&gt; all items are displayed"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default=0"}],"summary":"Returns courses thumbnails","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseThumbnailsIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/thumbnails/{id_thumbnail}/clone":{"post":{"tags":["Thumbnails"],"operationId":"Thumbnails./course/v1/thumbnails/{id_thumbnail}/clone","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/CourseThumbnailsCloneSchema"}},{"in":"path","name":"id_thumbnail","type":"integer","required":true,"description":"ID of the thumbnail that will be cloned"}],"summary":"Clone thumbnail and assigned it to a multidomain client","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseThumbnailsCloneResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/course/v1/thumbnails/{id}/usage":{"get":{"tags":["Thumbnails"],"operationId":"Thumbnails./course/v1/thumbnails/{id}/usage","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of image from type courselogo, course_cover or playerbg"},{"in":"query","name":"page","type":"integer","required":false,"description":"Requested page number result (starting from 1)."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Maximum number of results per page. Default to the platform setting for pagination."},{"in":"query","enum":["id","code","name"],"name":"sort_attr","type":"string","required":false,"description":"Sort the result by this column. Default value: id."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sort direction. Default value: asc."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in code and name."},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor."},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return &#039;cursor&#039; and prebuilt navigational &#039;_links&#039;. Accepts only 0 and 1. Default = 0."}],"summary":"View A Thumbnail Usage In Courses and Learning Plans","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/CourseThumbnailsUsageResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid or missing parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}}},"securityDefinitions":{"docebo_oauth":{"type":"oauth2","flow":"implicit","tokenUrl":"/oauth2/token","authorizationUrl":"/oauth2/authorize","scopes":{"api":"Common scope, used by the whole API"}}},"security":[{"docebo_oauth":["api"]}],"definitions":{"localizable":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of the localizable object. This controls whether or not the value or values property below will be populated.","collectionFormat":"brackets","enum":["single_value","multi_lang"]},"value":{"type":"string","description":"The scalar value of this localizable object, used for all languages. Only populated when \"type=single_value\"."},"values":{"type":"object","description":"A lang_code=>value structured object with the different localized names of the item, in each language, available within the platform."}}},"CourseCategoriesCreateSchema":{"type":"object","properties":{"code":{"type":"string","description":"Category code"},"title":{"$ref":"#/definitions/localizable","description":"Category title (translations in all languages or in specific language)"},"id_parent":{"type":"integer","description":"ID of the parent category under which the new category will be placed"}},"required":["title"]},"CourseCategoriesCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCategoriesCreateData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCategoriesCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCategoriesCreateData":{"required":["id"],"properties":{"id":{"type":"integer","description":"The new created category ID"}}},"CourseCategoriesCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCategoriesCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCategoriesCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCategoriesCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCategoriesCreateLast","description":"Link to the last page"}}},"CourseCategoriesCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCategoriesCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCategoriesCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCategoriesCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCategoriesDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response. Empty array","items":{"$ref":"#/definitions/CourseCategoriesDeleteData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCategoriesDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCategoriesDeleteData":{},"CourseCategoriesDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCategoriesDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCategoriesDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCategoriesDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCategoriesDeleteLast","description":"Link to the last page"}}},"CourseCategoriesDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCategoriesDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCategoriesDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCategoriesDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCategoriesUpdateSchema":{"type":"object","properties":{"code":{"type":"string","description":"Codename of the category which we want to edit"},"title":{"$ref":"#/definitions/localizable","description":"Category title (translations in all languages or in specific language)"},"id_parent":{"type":"integer","description":"ID of the parent of an existing category under which we want to move the category"}},"required":["title"]},"CourseCategoriesUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response. Empty array","items":{"$ref":"#/definitions/CourseCategoriesUpdateData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCategoriesUpdateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCategoriesUpdateData":{},"CourseCategoriesUpdateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCategoriesUpdateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCategoriesUpdateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCategoriesUpdateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCategoriesUpdateLast","description":"Link to the last page"}}},"CourseCategoriesUpdateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCategoriesUpdateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCategoriesUpdateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCategoriesUpdateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCategoriesViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCategoriesViewData","description":"Category details"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCategoriesViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCategoriesViewData":{"required":["names","code","is_root","path"],"properties":{"names":{"$ref":"#/definitions/localizable","description":"Names of the category, translated in all active languages"},"code":{"type":"string","description":"Category code"},"is_root":{"type":"boolean","description":"Flag if the category is the root one"},"id_parent":{"type":"integer","description":"ID of the parent category. Not returned if the category is the root one"},"path":{"type":"array","description":"The current path in the categories tree (retrieved as ordered list of category names)","items":{"type":"string"}}}},"CourseCategoriesViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCategoriesViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCategoriesViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCategoriesViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCategoriesViewLast","description":"Link to the last page"}}},"CourseCategoriesViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCategoriesViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCategoriesViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCategoriesViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseClassroomsFreeBusySchema":{"type":"object","required":["day","time_begin","time_end","timezone"],"properties":{"day":{"type":"string","description":"Availability day (YYYY-MM-DD format)"},"time_begin":{"type":"string","description":"Availability time begin (HH:mm:ss format)"},"time_end":{"type":"string","description":"Availability time end (HH:mm:ss format)"},"break_begin":{"type":"string","description":"Availability break begin (HH:mm:ss format)"},"break_end":{"type":"string","description":"Availability break end (HH:mm:ss format)"},"timezone":{"type":"string","description":"Timezone of the event (Europe/Rome format)"},"ignore_event":{"type":"string","description":"An event ID to exclude from the availability"}}},"CourseClassroomsFreeBusyResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseClassroomsFreeBusyData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseClassroomsFreeBusyData":{"required":["status"],"properties":{"status":{"description":"Classroom availability status","enum":["busy","free"],"type":"string"}}},"CourseCoursearchivedIndexResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedIndexData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedIndexData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of archived courses","items":{"$ref":"#/definitions/CourseCoursearchivedIndexItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedIndexItems":{"required":["archived_course_id","original_course_id","name","course_type","category_path","archived_date","author_id","create_date","archived_by","created_by","enrollments","training_materials"],"properties":{"archived_course_id":{"type":"integer","description":"Unique identifier of the archived course"},"original_course_id":{"type":"integer","description":"ID of the source course archived"},"code":{"type":"string","description":"Course code at archive time"},"name":{"type":"string","description":"Course name at archive time"},"course_type":{"type":"string","description":"Course type (e.g., elearning, classroom, webinar)"},"category_path":{"type":"string","description":"Full category path of the course"},"archived_date":{"type":"string","description":"Date when the course was archived (Y-m-d H:i:s)"},"author_id":{"type":"integer","description":"ID of the author/owner of the course"},"create_date":{"type":"string","description":"Creation date of the original course (Y-m-d H:i:s)"},"archived_by":{"$ref":"#/definitions/CourseCoursearchivedIndexArchivedBy","description":"Information about the archiving user"},"created_by":{"$ref":"#/definitions/CourseCoursearchivedIndexCreatedBy","description":"Information about the course author"},"enrollments":{"type":"integer","description":"Number of archived enrollments related to the course"},"training_materials":{"type":"integer","description":"Number of archived training materials for the course"}}},"CourseCoursearchivedIndexArchivedBy":{"required":["username","first_name","last_name","email"],"properties":{"username":{"type":"string","description":"Username of the archiving user"},"first_name":{"type":"string","description":"Display name of the archiving user"},"last_name":{"type":"string","description":"Last name of the archiving user"},"email":{"type":"string","description":"Email of the archiving user"}}},"CourseCoursearchivedIndexCreatedBy":{"required":["username","first_name","last_name","email"],"properties":{"username":{"type":"string","description":"Username of the author user"},"first_name":{"type":"string","description":"Display name of the author user"},"last_name":{"type":"string","description":"Last name of the author user"},"email":{"type":"string","description":"Email of the author user"}}},"CourseCoursearchivedGetArchivedCourseDetailsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDetailsData","description":"Archived course details"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseDetailsData":{"required":["id","original_course_id","uuid","name","course_type","category_path","description","archived_date","archived_by_id","archived_by_info","author_id","author_info","create_date","lms_default_language","course_default_language","last_update_by_id","last_update_by_info","last_update_date","certificate_default_id","certificate_default_name","certification","price","training_credits","content_partner","marketplace","instructors_count","languages"],"properties":{"id":{"type":"integer","description":"ID of the archived course"},"original_course_id":{"type":"integer","description":"ID of the original course before archiving"},"uuid":{"type":"string","description":"UUID of the archived course"},"name":{"type":"string","description":"Name of the archived course"},"course_type":{"type":"string","description":"Type of the archived course"},"category_path":{"type":"string","description":"Category path of the archived course"},"description":{"type":"string","description":"Description of the archived course"},"archived_date":{"type":"string","description":"Date when the course was archived"},"archived_by_id":{"type":"integer","description":"ID of the user who archived the course"},"archived_by_info":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDetailsArchivedByInfo","description":"Information about the user who archived the course"},"author_id":{"type":"integer","description":"ID of the course author"},"author_info":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDetailsAuthorInfo","description":"Information about the course author"},"create_date":{"type":"string","description":"Date when the course was originally created"},"lms_default_language":{"type":"string","description":"Default language of the LMS"},"course_default_language":{"type":"string","description":"Default language of the course"},"last_update_by_id":{"type":"integer","description":"ID of the user who last updated the course"},"last_update_by_info":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDetailsLastUpdateByInfo","description":"Information about the user who last updated the course"},"last_update_date":{"type":"string","description":"Date when the course was last updated"},"certificate_default_id":{"type":"integer","description":"ID of the default certificate"},"certificate_default_name":{"type":"string","description":"Name of the default certificate"},"certification":{"type":"string","description":"Certification information"},"price":{"type":"integer","description":"Price of the course"},"training_credits":{"type":"integer","description":"Training credits for the course"},"content_partner":{"type":"string","description":"Content partner information"},"marketplace":{"type":"string","description":"Marketplace information"},"instructors_count":{"type":"integer","description":"Number of instructors associated with the courses"},"languages":{"type":"array","description":"List of languages associated with the course","items":{"type":"string"}},"translations":{"type":"array","description":"List of translation language codes associated with the course","items":{"type":"string"}}}},"CourseCoursearchivedGetArchivedCourseDetailsArchivedByInfo":{"required":["username","first_name","last_name","email"],"properties":{"username":{"type":"string","description":"Username of the archiving user"},"first_name":{"type":"string","description":"Display name of the archiving user"},"last_name":{"type":"string","description":"Last name of the archiving user"},"email":{"type":"string","description":"Email of the archiving user"}}},"CourseCoursearchivedGetArchivedCourseDetailsAuthorInfo":{"required":["username","first_name","last_name","email"],"properties":{"username":{"type":"string","description":"Username of the author user"},"first_name":{"type":"string","description":"Display name of the author user"},"last_name":{"type":"string","description":"Last name of the author user"},"email":{"type":"string","description":"Email of the author user"}}},"CourseCoursearchivedGetArchivedCourseDetailsLastUpdateByInfo":{"required":["username","first_name","last_name","email"],"properties":{"username":{"type":"string","description":"Username of the last updater user"},"first_name":{"type":"string","description":"Display name of the last updater user"},"last_name":{"type":"string","description":"Last name of the last updater user"},"email":{"type":"string","description":"Email of the last updater user"}}},"CourseCoursearchivedGetArchivedCourseTrainingMaterialsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseTrainingMaterialsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseTrainingMaterialsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of archived training materials","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseTrainingMaterialsItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedGetArchivedCourseTrainingMaterialsItems":{"required":["archived_course_training_material_id","archived_course_id","name","type","language","language_code","author_id","author_info","uploaded_in_clor","language_derive_from_folder"],"properties":{"archived_course_training_material_id":{"type":"integer","description":"Unique identifier of the archived training material"},"archived_course_id":{"type":"integer","description":"Archived course identifier"},"name":{"type":"string","description":"Training material name at archive time"},"type":{"type":"string","description":"Training material type (e.g., scorm, file, video)"},"language":{"type":"string","description":"Training material language (if available)"},"language_code":{"type":"string","description":"Training material language code (if available)"},"author_id":{"type":"integer","description":"ID of the author of the training material"},"author_info":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseTrainingMaterialsAuthorInfo","description":"Author information (decoded JSON)"},"uploaded_in_clor":{"type":"boolean","description":"Whether the material is uploaded in CLOR"},"language_derive_from_folder":{"type":"boolean","description":"Whether the language is derived from the folder"}}},"CourseCoursearchivedGetArchivedCourseTrainingMaterialsAuthorInfo":{"required":["username","firstname","lastname","email"],"properties":{"username":{"type":"string","description":"Username of the author user"},"firstname":{"type":"string","description":"Display name of the author user"},"lastname":{"type":"string","description":"Lastname of the author user"},"email":{"type":"string","description":"Email of the author user"}}},"CourseCoursearchivedGetArchivedCourseEnrolmentsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseEnrolmentsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseEnrolmentsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of archived course enrolments","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseEnrolmentsItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedGetArchivedCourseEnrolmentsItems":{"required":["id","username","archive_date","archived_by","enrolment_status_code","enrolment_status_label"],"properties":{"id":{"type":"string","description":"ID of the archived enrollment (UUID hex with dashes)"},"username":{"type":"string","description":"Username of the user"},"archive_date":{"type":"string","description":"Date of the archive"},"archived_by":{"type":"string","description":"Username of the user who archived the course"},"enrolment_status_code":{"type":"string","description":"Code of the enrolment status"},"enrolment_status_label":{"type":"string","description":"Label of the enrolment status"}}},"CourseCoursearchivedGetArchivedCourseAdditionalFieldsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseAdditionalFieldsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseAdditionalFieldsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of archived course additional fields","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseAdditionalFieldsItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedGetArchivedCourseAdditionalFieldsItems":{"required":["name","type","value"],"properties":{"name":{"type":"string","description":"Name of the additional field"},"type":{"type":"string","description":"Type of the additional field"},"value":{"type":"string","description":"Value of the additional field"}}},"CourseCoursearchivedGetArchivedCourseSessionsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseSessionsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseSessionsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of archived course sessions","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseSessionsItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedGetArchivedCourseSessionsItems":{"required":["session_id","code","session_name","session_instructors_number","events"],"properties":{"session_id":{"type":"integer","description":"ID of the session"},"code":{"type":"string","description":"code of the session"},"session_name":{"type":"string","description":"Name of the session"},"session_instructors_number":{"type":"integer","description":"Number of instructors in the session"},"events":{"type":"array","description":"List of events in the session","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseSessionsEvents"}}}},"CourseCoursearchivedGetArchivedCourseSessionsEvents":{"required":["event_id","event_name","event_start_date","event_end_date","timezone","type","event_instructors_number"],"properties":{"event_id":{"type":"integer","description":"ID of the event"},"event_name":{"type":"string","description":"Name of the event"},"event_start_date":{"type":"string","description":"Start date of the event"},"event_end_date":{"type":"string","description":"End date of the event"},"timezone":{"type":"string","description":"Timezone of the event"},"type":{"type":"string","description":"Type of the event"},"event_instructors_number":{"type":"integer","description":"Number of instructors in the event"}}},"CourseCoursearchivedGetArchivedCourseCatalogsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseCatalogsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseCatalogsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of archived course catalogs","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseCatalogsItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedGetArchivedCourseCatalogsItems":{"required":["name"],"properties":{"name":{"type":"string","description":"Name of the catalog"}}},"CourseCoursearchivedGetArchivedEnrollmentDetailsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedEnrollmentDetailsData","description":"Returned object containing the response payload"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedEnrollmentDetailsData":{"required":["enrollment","sessions","has_certificate"],"properties":{"enrollment":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedEnrollmentDetailsEnrollment","description":"Enrollment details sourced from archived enrollment row"},"sessions":{"type":"array","description":"Archived sessions related to this enrollment (empty for elearning)","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedEnrollmentDetailsSessions"}},"has_certificate":{"type":"boolean","description":"True if certificate snapshot exists in archive; indicates presence of a certificate snapshot in archived data"}}},"CourseCoursearchivedGetArchivedEnrollmentDetailsEnrollment":{"required":["user_data","enrolment_date","completion_date","enrolment_status","archive_date","attendance_hours"],"properties":{"user_data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedEnrollmentDetailsUserData","description":"Snapshot of the enrolled user"},"enrolment_date":{"type":"string","description":"Enrollment creation datetime"},"completion_date":{"type":"string","description":"Enrollment completion datetime"},"enrolment_status":{"type":"string","description":"Enrollment status code as string"},"archive_date":{"type":"string","description":"Datetime when the enrollment was archived"},"attendance_hours":{"type":"integer","description":"Total attendance hours aggregated from events (minutes/60 floored)"}}},"CourseCoursearchivedGetArchivedEnrollmentDetailsUserData":{"required":["id","username","firstname","lastname","email"],"properties":{"id":{"type":"integer","description":"User ID"},"username":{"type":"string","description":"Username"},"firstname":{"type":"string","description":"First name"},"lastname":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"}}},"CourseCoursearchivedGetArchivedEnrollmentDetailsSessions":{"required":["id","name","code","start_date","end_date","evaluation","score","events"],"properties":{"id":{"type":"integer","description":"Original session ID"},"name":{"type":"string","description":"Session name (archived or snapshot)"},"code":{"type":"string","description":"Session code (archived or snapshot)"},"start_date":{"type":"string","description":"Session start datetime"},"end_date":{"type":"string","description":"Session end datetime"},"evaluation":{"description":"Session evaluation outcome if available; mapped from numeric status","enum":["passed","not_passed"],"type":"string"},"score":{"type":"integer","description":"Evaluation score when available"},"events":{"type":"array","description":"Attendance events parsed from archived attendance_info","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedEnrollmentDetailsEvents"}}}},"CourseCoursearchivedGetArchivedEnrollmentDetailsEvents":{"required":["id","name","start_at","end_at","timezone","type","attendance"],"properties":{"id":{"type":"integer","description":"Event ID"},"name":{"type":"string","description":"Event name"},"start_at":{"type":"string","description":"Event start datetime"},"end_at":{"type":"string","description":"Event end datetime"},"timezone":{"type":"string","description":"Event timezone"},"type":{"type":"string","description":"Event type (e.g., onsite, online, flexible)"},"attendance":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedEnrollmentDetailsAttendance","description":"Attendance details for the event"}}},"CourseCoursearchivedGetArchivedEnrollmentDetailsAttendance":{"required":["status","effective_duration"],"properties":{"status":{"description":"Attendance status mapped from raw value","enum":["present","absent"],"type":"string"},"effective_duration":{"type":"integer","description":"Effective attended duration in minutes"}}},"CourseCoursearchivedGetArchivedCourseCertificateTemplatesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseCertificateTemplatesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseCertificateTemplatesData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of archived course certificate templates","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseCertificateTemplatesItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedGetArchivedCourseCertificateTemplatesItems":{"required":["name","default"],"properties":{"name":{"type":"string","description":"Name of the template"},"default":{"type":"boolean","description":"True if this is the default template"}}},"CourseCoursearchivedGetArchivedCourseChannelsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseChannelsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseChannelsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of archived course channels","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseChannelsItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedGetArchivedCourseChannelsItems":{"required":["name"],"properties":{"name":{"type":"string","description":"Name of the channel"}}},"CourseCoursearchivedDeleteArchivedCourseResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedDeleteArchivedCourseData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedDeleteArchivedCourseData":{"required":["archived_course_id","job_id"],"properties":{"archived_course_id":{"type":"integer","description":"Deleted archived course id"},"job_id":{"type":"string","description":"Background job identifier deleting archived enrollments"}}},"CourseCoursearchivedGetArchivedCourseDependenciesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDependenciesData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursearchivedGetArchivedCourseDependenciesData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"List of course dependencies (denormalized - one row per dependency, courses without dependencies are excluded)","items":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDependenciesItems"}},"count":{"type":"integer","description":"Number of items in the current page"},"has_more_data":{"type":"boolean","description":"True if there are more pages after the current one"},"current_page":{"type":"integer","description":"Current page number (1-based)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages available"},"total_count":{"type":"integer","description":"Total number of items in the full result set"}}},"CourseCoursearchivedGetArchivedCourseDependenciesItems":{"required":["course_id","course_name","dependency"],"properties":{"course_id":{"type":"integer","description":"Course ID"},"course_name":{"type":"string","description":"Course name"},"dependency":{"$ref":"#/definitions/CourseCoursearchivedGetArchivedCourseDependenciesDependency","description":"Dependency details"}}},"CourseCoursearchivedGetArchivedCourseDependenciesDependency":{"required":["name","type"],"properties":{"name":{"type":"string","description":"Name of the dependency (LP or Group)"},"type":{"type":"string","description":"Type of dependency (learning_plan or automatic_group)"}}},"CourseCoursesDeleteSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects with course properties that need to be deleted","items":{"$ref":"#/definitions/CourseCoursesDeleteItems"}}}},"CourseCoursesDeleteItems":{"required":["id"],"properties":{"id":{"type":"integer","description":"Internal ID of the course, that need to be deleted"}}},"CourseCoursesDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/CourseCoursesDeleteData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesDeleteData":{"required":["row_index","success"],"properties":{"row_index":{"type":"integer","description":"Delete ID for the current record"},"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Optional error message"},"output":{"$ref":"#/definitions/CourseCoursesDeleteOutput","description":"An output object"}}},"CourseCoursesDeleteOutput":{"properties":{"id":{"type":"integer","description":"Deleted course ID in the LMS"},"batch_item_id":{"type":"string","description":"User specified ID for single batch item, passed in input parameters"}}},"CourseCoursesDeleteLinks":{},"CourseCoursesIndexResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesIndexData","description":"Courses listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesIndexData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of all (managed) courses","items":{"$ref":"#/definitions/CourseCoursesIndexItems"}}}},"CourseCoursesIndexItems":{"required":["id","title","slug_name","code","uidCourse","type","language","language_label","published","category_name","price","course_status","imported_from_content_marketplace","outdated","field_xxx","decommissioned_at","removed_at","last_update","update_data"],"properties":{"id":{"type":"integer","description":"ID of the course"},"title":{"type":"string","description":"Course name"},"slug_name":{"type":"string","description":"The slug name of the course, normally required to build a proper url to access it"},"code":{"type":"string","description":"Codename of the course"},"uidCourse":{"type":"string","description":"UidCourse of the course"},"type":{"description":"Type of the item","enum":["elearning","classroom","learning_plan","certification","catalog","additional_field"],"type":"string"},"language":{"type":"string","description":"Language of the course."},"language_label":{"type":"string","description":"Course language code translated into the currently logged in user language."},"multi_languages":{"type":"array","description":"Course multi-language information. Only available for E-learning courses when the multi-language feature is on.","items":{"$ref":"#/definitions/CourseCoursesIndexMultiLanguages"}},"published":{"type":"boolean","description":"Course published flag (true - published, false - in maintenance|deleted|canceled)"},"category_name":{"type":"string","description":"Localizable name of the course category"},"price":{"type":"number","description":"Course price"},"prices":{"$ref":"#/definitions/CourseCoursesIndexPrices","description":"The object that contains the course prices"},"course_status":{"description":"Status of the course","enum":["published","in_maintenance"],"type":"string"},"imported_from_content_marketplace":{"type":"boolean","description":"Is course imported from Content Marketplace"},"creation_date":{"type":"string","format":"date","description":"Course date of creation in UTC yyyy-MM-dd HH:mm:ss"},"enrolled_count":{"type":"number","description":"How many people are enrolled in this course"},"courses_count":{"type":"number","description":"Number of courses, assigned to the Learning Plan"},"waiting_list":{"type":"number","description":"How many people are in the waiting list of this course"},"session_waiting_list":{"type":"number","description":"How many people are in the session waiting list of this course"},"users_without_session_count":{"type":"number","description":"How many people are not enrolled in any sessions of this course"},"thumbnail":{"type":"string","description":"Course thumbnail URL"},"start_date":{"type":"string","format":"date","description":"Course start date in UTC yyyy-MM-dd"},"end_date":{"type":"string","format":"date","description":"Course end date in UTC yyyy-MM-dd"},"seats":{"type":"string","description":"Course available and total seats (Power User Only)"},"sessions_count":{"type":"integer","description":"Number of sessions (in case of Classroom course type)"},"actions":{"type":"array","description":"The list of actions that the current user can do over the item","items":{"type":"string"}},"outdated":{"$ref":"#/definitions/CourseCoursesIndexOutdated","description":"Mark as outdated information"},"field_xxx":{"type":"string","description":"Additional course field value. In field_xxx, &quot;xxx&quot; is the field ID. There are multiple additional fields created using this patter"},"has_esignature_enabled":{"type":"boolean","description":"Whether or not the course has e-signature enabled. It would only be returned when ESignature App is enabled."},"decommissioned_at":{"type":"string","format":"date","description":"Closer in time date of training material decommissioning, if any. If null, no training material is planned to be decommissioned"},"removed_at":{"type":"string","format":"date","description":"Closer in time date of training material removement, if any. If null, no training material is planned to be removed"},"last_update":{"type":"string","format":"date","description":"Last Update datetime of the course in UTC yyyy-MM-dd HH:mm:ss"},"average_completion_time":{"type":"integer","description":"Estimated average time to complete the course (in seconds)"},"update_data":{"$ref":"#/definitions/CourseCoursesIndexUpdateData","description":"Information about the last update of the course."},"course_information_translations":{"type":"array","description":"Course information translations. It can be empty. Returned only if with_translations parameter is true","items":{"$ref":"#/definitions/CourseCoursesIndexCourseInformationTranslations"}}}},"CourseCoursesIndexMultiLanguages":{"required":["code","name","browser_code"],"properties":{"code":{"type":"string","description":"Code of the course language"},"name":{"type":"string","description":"Name of the course language"},"browser_code":{"type":"string","description":"Browser code (2 characters) of the course language"}}},"CourseCoursesIndexPrices":{"properties":{"currency_code":{"type":"number","description":"Price value. Replace currency_code with a ISO currency code or with the DTC (docebo training credits) currency code. The value should be a number."}}},"CourseCoursesIndexOutdated":{"required":["total_users","already_marked"],"properties":{"total_users":{"type":"integer","description":"The number of the users that marks the content as outdated"},"already_marked":{"type":"boolean","description":"Whether or not the logged user already marked the asset as outdated"}}},"CourseCoursesIndexUpdateData":{"required":["updated_by","updated_at"],"properties":{"updated_by":{"$ref":"#/definitions/CourseCoursesIndexUpdatedBy","description":"Information for the user who created course. Its value can be null"},"updated_at":{"type":"string","format":"date","description":"Course last update date and time UTC"}}},"CourseCoursesIndexUpdatedBy":{"required":["id","fullname"],"properties":{"id":{"type":"integer","description":"The ID of the user who updated the course"},"fullname":{"type":"string","description":"Full name of the user who updated the course"}}},"CourseCoursesIndexCourseInformationTranslations":{"required":["lang_code","name","description","short_description","source"],"properties":{"lang_code":{"type":"string","description":"Language code of the translation"},"name":{"type":"string","description":"Translated course title"},"description":{"type":"string","description":"Translated course description"},"short_description":{"type":"string","description":"Translated short course description. It can be null"},"source":{"type":"string","description":"Source of the translation (e.g. as_default, manual)"}}},"CourseCoursesUpdateSchema":{"type":"object","properties":{"status":{"description":"Course status","enum":["published","under_maintenance"],"type":"string"},"code":{"type":"string","description":"Course code"},"name":{"type":"string","description":"Course name. The name cannot be composed of special characters only"},"description":{"type":"string","description":"Course description"},"short_description":{"type":"string","description":"Course short description. Max allowed size: 130 characters. It also accepts null to unset the value"},"language_code":{"type":"string","description":"Course language. Format &quot;english&quot;/&quot;spanish&quot;/&quot;german&quot;. When the course multi-language feature is active, this will hold the default language of the course."},"multilanguage_codes":{"type":"array","description":"The list of additional language codes for this course (usable only with the course multilanguage feature). If the multilanguage feature is active and language_code is passed, this field is mandatory. It can be NULL or empty array (multilanguage inactive/deactivated), or an array of language strings, written in the same format as the language_code parameter.","items":{"type":"string"}},"category_id":{"type":"integer","description":"Id of category assigned"},"thumbnail_id":{"type":"integer","description":"Id of CoreAsset type image to be applied as this course&#039;s thumbnail. It also accepts null to unset the value"},"header_layout":{"$ref":"#/definitions/CourseCoursesUpdateHeaderLayout","description":"Header Layout configuration for this Course. It also accepts null to unset the value"},"cover_id":{"type":"integer","description":"The Id of Course cover. The Id should be existing core asset record and its type should be course_cover. It also accepts null to unset the value"},"skills":{"type":"array","description":"Array of ESCO skill codes to be added to the course. Max: 15","items":{"type":"string"}},"credits":{"type":"number","description":"Number greater than 0. It also accepts null to unset the value"},"certificate_id":{"type":"integer","description":"The certificate template for this course. It also accepts null to unset the value. This attribute is ignored when the toggle release/weekly/multiple-certificates-per-course is ON"},"certificate":{"$ref":"#/definitions/CourseCoursesUpdateCertificate","description":"The certificate options for this course. It also accepts null to unset the value. This attribute is accepted only when the toggle release/weekly/multiple-certificates-per-course is ON"},"certification_id":{"type":"integer","description":"The certification to assign to the course. It also accepts null to unset the value"},"esignature":{"$ref":"#/definitions/CourseCoursesUpdateEsignature","description":"E-Signature options"},"average_completion_time":{"type":"integer","description":"Average completion time in seconds"},"enrollment_options":{"$ref":"#/definitions/CourseCoursesUpdateEnrollmentOptions","description":"Enrollment options"},"time_options":{"$ref":"#/definitions/CourseCoursesUpdateTimeOptions","description":"Time options controls"},"rating":{"$ref":"#/definitions/CourseCoursesUpdateRating","description":"Rating options controls. Accepts null to erase existing values"},"social_sharing":{"$ref":"#/definitions/CourseCoursesUpdateSocialSharing","description":"Social sharing options control. Accepts null to erase existing values"},"lo_navigation":{"$ref":"#/definitions/CourseCoursesUpdateLoNavigation","description":"Learning objects navigation controls"},"course_player":{"$ref":"#/definitions/CourseCoursesUpdateCoursePlayer","description":"Course player settings"},"vilt_options":{"$ref":"#/definitions/CourseCoursesUpdateViltOptions","description":"VILT options. Only Allowed if VILT Course"},"score_options":{"$ref":"#/definitions/CourseCoursesUpdateScoreOptions","description":"Score options"},"ecommerce_options":{"$ref":"#/definitions/CourseCoursesUpdateEcommerceOptions","description":"Ecommerce configuration options. Only Allowed if Ecommerce app is active"},"catalog_options":{"$ref":"#/definitions/CourseCoursesUpdateCatalogOptions","description":"Catalog options configuration"},"content_partner":{"$ref":"#/definitions/CourseCoursesUpdateContentPartner","description":"Content partner configuration options. Only allowed if ContentPartner app is active. It accepts also null to unset the value."},"equivalent_courses":{"type":"array","description":"Array of equivalent courses. Max 30","items":{"$ref":"#/definitions/CourseCoursesUpdateEquivalentCourses"}},"seo_options":{"$ref":"#/definitions/CourseCoursesUpdateSeoOptions","description":"SEO options. Only when SEO App is active."},"course_information_translations":{"type":"array","description":"Array of translations for this course","items":{"$ref":"#/definitions/CourseCoursesUpdateCourseInformationTranslations"}}}},"CourseCoursesUpdateHeaderLayout":{"required":["mode"],"properties":{"mode":{"description":"Header Layout mode","enum":["color","cover_image","basic"],"type":"string"},"color":{"type":"string","description":"Header Layout color. It is only considered if header_layout.mode is &quot;color&quot;"}}},"CourseCoursesUpdateCertificate":{"required":["id"],"properties":{"id":{"type":"integer","description":"The ID of the default certificate template"},"additional_certificates":{"type":"array","description":"An array of all additional certificates of this course. Accepts up to 50 objects. It accepts also null to delete all the associated additional certificate templates","items":{"$ref":"#/definitions/CourseCoursesUpdateAdditionalCertificates"}},"additional_certificate_options":{"$ref":"#/definitions/CourseCoursesUpdateAdditionalCertificateOptions","description":"Course multiple certificates generation options."}}},"CourseCoursesUpdateAdditionalCertificates":{"required":["sequence","certificate_id","association_entity"],"properties":{"sequence":{"type":"integer","description":"The order of the additional certificate"},"certificate_id":{"type":"integer","description":"The ID of the additional certificate template"},"association_entity":{"$ref":"#/definitions/CourseCoursesUpdateAssociationEntity","description":"The association options. Whether the association is a group or branch"}}},"CourseCoursesUpdateAssociationEntity":{"required":["id","type"],"properties":{"id":{"type":"integer","description":"The ID of a group or branch"},"type":{"description":"The association type","enum":["group","branch"],"type":"string"}}},"CourseCoursesUpdateAdditionalCertificateOptions":{"required":["enable_multiple_certificates_generation","certificates_to_generate"],"properties":{"enable_multiple_certificates_generation":{"type":"boolean","description":"Enable the use of multiple certificates generation."},"certificates_to_generate":{"type":"integer","description":"The number of certificates that can be generated."}}},"CourseCoursesUpdateEsignature":{"required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether E-Signature is enabled or not."},"title":{"type":"string","description":"E-Signature title. Required if &quot;enabled&quot; is true"},"description":{"type":"string","description":"E-Signature description. Required if &quot;enabled&quot; is true"}}},"CourseCoursesUpdateEnrollmentOptions":{"properties":{"self_unenrollment_mode":{"description":"it accepts also null to unset value","enum":["enrolled_but_completed","enrolled_and_completed"],"type":"string"},"allow_self_session_unenrollment":{"type":"boolean","description":"Applies only to vILT"},"allow_self_session_change":{"type":"boolean","description":"Applies only to vILT"},"allow_enrollment_deeplink":{"type":"boolean","description":"Enables the use of enrollment link"},"enrollment_code":{"type":"string","description":"Unique Code. Accepts only alphanumeric strings. Only available if SubscriptionsCodeApp is active. Cannot duplicate with another course or subscription code in the SubscriptionApp."},"course_rsvp":{"type":"boolean","description":"RSVP flag value at course level. The field can be updated only when the Advance Settings &gt; ILT &gt; Enrollment Invitations via External Calendar is selected, and the course is VILT one. Allowed values: false|true"},"quick_enrollment_enabled":{"type":"boolean","description":"Defines whether quick enrollment should be enabled at course level. It also accepts null to unset the value. Only Available for eLearning Courses."},"hide_attendees":{"type":"boolean","description":"hide_attendees at course level. The field can be updated only when the Advance Settings &gt; ILT &gt; Enrollment Invitations via External Calendar is selected, and the course is VILT one. It needs rsvp toggle Allowed values: false|true"},"enable_session_unenrolment_on_user_deactivated":{"type":"boolean","description":"If true when a user is deactivated he will be unenrolled from all the sessions to which he is enrolled. Only for classroom / ILT courses"}}},"CourseCoursesUpdateTimeOptions":{"properties":{"date_begin":{"type":"string","format":"date","description":"Accept dates with format of yyyy-MM-dd. Example: 2021-06-18. If set to null, it removes existing value. Only Available for eLearning Courses"},"date_end":{"type":"string","format":"date","description":"Accept dates with format of yyyy-MM-dd. Example: 2021-06-18. If set to null, it removes existing value. Only Available for eLearning Courses"},"duration":{"$ref":"#/definitions/CourseCoursesUpdateDuration","description":"Defines the duration of an enrollment for an attendee. If set to null it disables the enrollment validity period without affecting existing enrollment dates"},"soft_deadline":{"type":"boolean","description":"If set to null, it removes existing value. Only Available for eLearning Courses"}}},"CourseCoursesUpdateDuration":{"required":["days","trigger"],"properties":{"days":{"type":"integer","description":"Duration, in days, of an active enrollment."},"trigger":{"description":"When the duration of the active enrollment starts to count. Only Available for eLearning Courses","enum":["first_access","enrollment_creation"],"type":"string"},"update_existing":{"type":"boolean","description":"When passed as true it would update the enrollment active from/to dates for all currently existing enrollments. Only Available for eLearning Courses"}}},"CourseCoursesUpdateRating":{"required":["enabled","mode"],"properties":{"enabled":{"type":"boolean","description":"Defines whether social rating should be enabled. If false existing values are erased"},"mode":{"description":"Required only if enabled is set to true","enum":["disabled","public","enrolled","completed"],"type":"string"}}},"CourseCoursesUpdateSocialSharing":{"required":["enabled","mode","networks"],"properties":{"enabled":{"type":"boolean","description":"Defines whether social sharing should be enabled. If false existing values are erased"},"mode":{"description":"Required only if enabled is set to true","enum":["disabled","enrolled","completed"],"type":"string"},"networks":{"type":"array","description":"Required only if enabled is set to true and mode is different from disabled. Can be &quot;twitter&quot;, &quot;linkedin&quot;, or both.","items":{"type":"string"}},"share_score":{"type":"boolean","description":"Defines whether users should be able to share their scores if course is completed. This attribute shall be accepted only if enabled is set to true and mode is different than disabled."}}},"CourseCoursesUpdateLoNavigation":{"required":["mode"],"properties":{"mode":{"description":"Defines the navigation mode","enum":["free","sequential","first_required","all_but_last_required"],"type":"string"},"max_attempts":{"type":"integer","description":"Defines the maximum number of attempts. Accept numbers greater than 0. It accepts also null to unset the value."}}},"CourseCoursesUpdateCoursePlayer":{"properties":{"landing_page":{"description":"Defines landing page for the course player. Accepts null to unset value","enum":["player","overview"],"type":"string"},"background_image":{"$ref":"#/definitions/CourseCoursesUpdateBackgroundImage","description":"Defines background image settings. Accepts null to unset settings"},"table_of_content":{"type":"boolean","description":"Accepts null to unset the value"},"autoplay":{"type":"boolean","description":"Accepts null to unset the value"},"lightbox_navigation":{"type":"boolean","description":"Accepts null to unset the value"},"player_appearance":{"description":"Accepts null to unset the value","enum":["light","dark"],"type":"string"},"focus_mode":{"type":"boolean","description":"Accepts null to unset the value"},"harmony_tutoring":{"type":"boolean","description":"Accepts null to unset the value"}}},"CourseCoursesUpdateBackgroundImage":{"required":["image_id","mode"],"properties":{"image_id":{"type":"integer","description":"Corresponding player background image id. It also accepts null to unset the value"},"mode":{"description":"Background image mode","enum":["adaptive","original_size"],"type":"string"}}},"CourseCoursesUpdateViltOptions":{"required":["course_completion"],"properties":{"course_completion":{"$ref":"#/definitions/CourseCoursesUpdateCourseCompletion","description":"Course completion options."}}},"CourseCoursesUpdateCourseCompletion":{"required":["mode"],"properties":{"mode":{"description":"The mode of course completion","enum":["single_session","custom_count"],"type":"string"},"percentage":{"type":"integer","description":"Required only if mode is custom_count"}}},"CourseCoursesUpdateScoreOptions":{"properties":{"initial_score_lo_id":{"type":"integer","description":"The id of a LO that can have score. It also accepts null to unset the value"},"final_score":{"$ref":"#/definitions/CourseCoursesUpdateFinalScore","description":"Final score options."}}},"CourseCoursesUpdateFinalScore":{"required":["calculation_mode"],"properties":{"calculation_mode":{"description":"The mode for calculating final score","enum":["last_lo","specific_lo","sum_los","average_los"],"type":"string"},"specific_lo_id":{"type":"integer","description":"Required only if calculation_mode is specific_lo"}}},"CourseCoursesUpdateEcommerceOptions":{"required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"whether or not the course is on sale"},"price":{"type":"integer","description":"Required if enabled is true. The price of the course in cents, acceptable values are integers between 1 and 999999999999 included. It cannot be provided if enabled is ‘false’."},"affiliate_price":{"type":"integer","description":"The content partner price in cents. It cannot be provided if enabled is false. It requires content partner to be set for the course"},"prices":{"$ref":"#/definitions/CourseCoursesUpdatePrices","description":"The object that contains the course prices"}}},"CourseCoursesUpdatePrices":{"properties":{"currency_code":{"type":"integer","description":"Price value. Replace currency_code with a ISO currency code or with the DTC (docebo training credits) currency code. The value should be a number."}}},"CourseCoursesUpdateCatalogOptions":{"properties":{"mode":{"description":"Catalog visibility mode","enum":["public","internal","enrolled"],"type":"string"},"self_enrollment":{"$ref":"#/definitions/CourseCoursesUpdateSelfEnrollment","description":"Self enrollment config object"},"enrollment_quota":{"$ref":"#/definitions/CourseCoursesUpdateEnrollmentQuota","description":"Enrolment quota settings object. Accepts null to reset values"},"waiting_list":{"$ref":"#/definitions/CourseCoursesUpdateWaitingList","description":"Waiting list settings"},"demo_material_name":{"type":"string","description":"the name of a demo material uploaded already on S3"}}},"CourseCoursesUpdateSelfEnrollment":{"required":["mode"],"properties":{"mode":{"description":"Defines whether self enrollment is disabled/enabled or possible during a timeframe for this course","enum":["disabled","enabled","timeframe"],"type":"string"},"start_date":{"type":"string","format":"date","description":"Optional. Only accept formats like YYYY-MM-DD, it accepts null to unset the value, only allowed if &quot;mode&quot; = &quot;timeframe&quot;"},"end_date":{"type":"string","format":"date","description":"Optional. Only accept formats like YYYY-MM-DD, it accepts null to unset the value, only allowed if &quot;mode&quot; = &quot;timeframe&quot;"},"policy":{"description":"Only allowed and required if &quot;mode&quot; different from &quot;disabled&quot;","enum":["only_admin","pending_admin","free"],"type":"string"}}},"CourseCoursesUpdateEnrollmentQuota":{"required":["limit"],"properties":{"limit":{"type":"integer","description":"The limit of users enrolled to the course"}}},"CourseCoursesUpdateWaitingList":{"properties":{"enabled":{"type":"boolean","description":"Whether waiting list is enabled or not"},"automatic_enrollment":{"type":"boolean","description":"Whether users in waiting list get enrolled automatically if a spot is freed. When course is set on selling this attribute is ignored."}}},"CourseCoursesUpdateContentPartner":{"properties":{"additional_fields_enabled":{"type":"boolean","description":"Defines whether the additional fields should be active for this course"},"additional_fields":{"type":"array","description":"Additional fields configuration. Required if there are mandatory customizable additional fields. Allowed maximum of 10.","items":{"$ref":"#/definitions/CourseCoursesUpdateAdditionalFields"}}}},"CourseCoursesUpdateAdditionalFields":{"required":["id","value"],"properties":{"id":{"type":"integer","description":"Id of the additional field whose value is being set"},"value":{"type":"string","description":"Value of the additional field to set. Should be either int, string or valid date format (yyyy-mm-dd) according to the field type."}}},"CourseCoursesUpdateEquivalentCourses":{"required":["course_id","mode"],"properties":{"course_id":{"type":"integer","description":"Id of equivalent course"},"mode":{"description":"Mode of equivalence relation","enum":["source","target","bidirectional"],"type":"string"}}},"CourseCoursesUpdateSeoOptions":{"properties":{"meta_description":{"type":"string","description":"Seo meta description content. Can be null"},"redirect_to":{"type":"string","description":"Redirect the user to this url when visit the course page. Can be null"},"custom_slug":{"type":"string","description":"Custom slug for the course url. Can be null"}}},"CourseCoursesUpdateCourseInformationTranslations":{"required":["lang_code"],"properties":{"lang_code":{"type":"string","description":"The lang code of the translation"},"short_description":{"type":"string","description":"The translated short description. Max 130 chars."},"name":{"type":"string","description":"The translated course name. Max 255 chars."},"description":{"type":"string","description":"The translated description."},"source":{"description":"The translation source","enum":["as_default","manual","ai"],"type":"string"}}},"CourseCoursesUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesUpdateData","description":"Results of the assign process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesUpdateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesUpdateData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"The response status"}}},"CourseCoursesUpdateLinks":{},"CourseCoursesViewResponse":{"required":["data","version","extra_data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesViewData","description":"Success or failure to find course"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/CourseCoursesViewExtraData","description":"An object with extra data"},"_links":{"$ref":"#/definitions/CourseCoursesViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesViewData":{"required":["id","status","type","uid","code","slug_name","name","short_description","description","created_on","created_by","updated_on","language","category","thumbnail","cover","average_completion_time","enrollment_options","time_options","lo_navigation","course_player","certificate","catalog_options","rating","social_sharing","score_options","credits","is_new_certification_association","update_data","course_information_translations"],"properties":{"id":{"type":"integer","description":"ID of the course"},"status":{"description":"Status of the course","enum":["published","under_maintenance"],"type":"string"},"type":{"description":"Type of the course","enum":["elearning","classroom"],"type":"string"},"uid":{"type":"string","description":"Code ID of the course"},"code":{"type":"string","description":"Internal codename of the course"},"slug_name":{"type":"string","description":"Course slug name"},"name":{"type":"string","description":"Course name"},"short_description":{"type":"string","description":"Course short description"},"description":{"type":"string","description":"Course description"},"created_on":{"type":"string","format":"date","description":"Course creation date and time UTC"},"created_by":{"$ref":"#/definitions/CourseCoursesViewCreatedBy","description":"Information for the user who created course. Its value can be null"},"updated_on":{"type":"string","format":"date","description":"Course update date and time UTC"},"language":{"$ref":"#/definitions/CourseCoursesViewLanguage","description":"Course language information"},"category":{"$ref":"#/definitions/CourseCoursesViewCategory","description":"Course category information"},"thumbnail":{"$ref":"#/definitions/CourseCoursesViewThumbnail","description":"Course thumbnail object with additional information. It can be null"},"cover":{"$ref":"#/definitions/CourseCoursesViewCover","description":"Course cover object with additional information. It can be null"},"header_layout":{"$ref":"#/definitions/CourseCoursesViewHeaderLayout","description":"Header Layout configuration for this course. Only returned if a custom configuration was defined for this course"},"skills":{"$ref":"#/definitions/CourseCoursesViewSkills","description":"An array with skill objects. Only returned if the skills-phase-1-1 toggle is enabled"},"esignature":{"$ref":"#/definitions/CourseCoursesViewEsignature","description":"ESignature information. Only returned when ESignature App is active and enabled from the app&#039;s settings"},"vilt_options":{"$ref":"#/definitions/CourseCoursesViewViltOptions","description":"VILT options. Only returned for VILT courses"},"average_completion_time":{"type":"integer","description":"Estimated average time to complete the course (in seconds)"},"enrollment_options":{"$ref":"#/definitions/CourseCoursesViewEnrollmentOptions","description":"Course enrollment options"},"time_options":{"$ref":"#/definitions/CourseCoursesViewTimeOptions","description":"Course time options"},"lo_navigation":{"$ref":"#/definitions/CourseCoursesViewLoNavigation","description":"Learning object navigation"},"course_player":{"$ref":"#/definitions/CourseCoursesViewCoursePlayer","description":"Course player configuration"},"certificate":{"$ref":"#/definitions/CourseCoursesViewCertificate","description":"Course certificate data. It can be null"},"catalog_options":{"$ref":"#/definitions/CourseCoursesViewCatalogOptions","description":"Various options relative to catalogs"},"equivalent_courses":{"type":"array","description":"An array of max 30 objects with equivalent courses","items":{"$ref":"#/definitions/CourseCoursesViewEquivalentCourses"}},"ecommerce_options":{"$ref":"#/definitions/CourseCoursesViewEcommerceOptions","description":"Returned when the Ecommerce App is enabled"},"content_partner":{"$ref":"#/definitions/CourseCoursesViewContentPartner","description":"The content partner properties for this course, if a partner has been assigned. Only returned when the ContentPartner App is enabled"},"rating":{"$ref":"#/definitions/CourseCoursesViewRating","description":"Course rating options"},"social_sharing":{"$ref":"#/definitions/CourseCoursesViewSocialSharing","description":"Course sharing options"},"score_options":{"$ref":"#/definitions/CourseCoursesViewScoreOptions","description":"Score options"},"credits":{"type":"number","format":"float","description":"Course credits"},"certification":{"$ref":"#/definitions/CourseCoursesViewCertification","description":"Certification information. Only available when the Certification App is enabled. It can be null"},"seo_options":{"$ref":"#/definitions/CourseCoursesViewSeoOptions","description":"SEO options. Only when SEO App is active."},"proctoring":{"$ref":"#/definitions/CourseCoursesViewProctoring","description":"Only present when Honorlock app is enabled."},"multi_languages":{"type":"array","description":"Course multi-language information. Only available for E-learning courses when the multi-language feature is on.","items":{"$ref":"#/definitions/CourseCoursesViewMultiLanguages"}},"is_new_certification_association":{"type":"boolean","description":"Returns true if the course is associated with at least one new certification"},"update_data":{"$ref":"#/definitions/CourseCoursesViewUpdateData","description":"Information about the last update of the course."},"course_information_translations":{"type":"array","description":"Course information translations. It can be null","items":{"$ref":"#/definitions/CourseCoursesViewCourseInformationTranslations"}}}},"CourseCoursesViewCreatedBy":{"required":["id","fullname"],"properties":{"id":{"type":"integer","description":"The ID of the user who created the course"},"fullname":{"type":"string","description":"Full name of the user who created the course"}}},"CourseCoursesViewLanguage":{"required":["code","name","browser_code"],"properties":{"code":{"type":"string","description":"Code of the course language"},"name":{"type":"string","description":"Name of the course language"},"browser_code":{"type":"string","description":"Browser code (2 characters) of the course language"}}},"CourseCoursesViewCategory":{"required":["id","code","name","path","language"],"properties":{"id":{"type":"integer","description":"ID of the category containing the course"},"code":{"type":"string","description":"Code of the course category"},"name":{"type":"string","description":"Name of the course category"},"path":{"type":"array","description":"Category path, ordered","items":{"type":"string"}},"language":{"type":"string","description":"Language of category"}}},"CourseCoursesViewThumbnail":{"required":["id","name","url","width","height","filesize","created_by","used_by_count","actions"],"properties":{"id":{"type":"integer","description":"Internal ID of the thumbnail"},"name":{"type":"string","description":"Original file name (human friendly version)"},"url":{"type":"string","description":"S3 URL to the image resource"},"width":{"type":"integer","description":"Thumbnail width in px"},"height":{"type":"integer","description":"Thumbnail height in px"},"filesize":{"type":"integer","description":"Thumbnail file size in bytes"},"created_by":{"$ref":"#/definitions/CourseCoursesViewCreatedByL2","description":"Information for the user who created the thumbnail"},"used_by_count":{"type":"integer","description":"The count of the items (Courses or Learning plans) that are using the image based on the image type. It holds the full count of the items and does not have any PU visibility filters."},"actions":{"description":"Possible actions on the thumbnail available to current user","enum":["edit","usage","copy_to_multidomain","download","delete"],"type":"string"}}},"CourseCoursesViewCreatedByL2":{"required":["id","username","firstname","lastname"],"properties":{"id":{"type":"integer","description":"ID of the creator user"},"username":{"type":"string","description":"Username of the creator user"},"firstname":{"type":"string","description":"First name of the creator user"},"lastname":{"type":"string","description":"Last name of the creator user"}}},"CourseCoursesViewCover":{"required":["id","name","url","width","height","filesize","created_by","used_by_count","actions"],"properties":{"id":{"type":"integer","description":"Internal ID of the cover image"},"name":{"type":"string","description":"Original file name (human friendly version)"},"url":{"type":"string","description":"S3 URL to the image resource"},"width":{"type":"integer","description":"Cover image width in px"},"height":{"type":"integer","description":"Cover image height in px"},"filesize":{"type":"integer","description":"Cover image file size in bytes"},"created_by":{"$ref":"#/definitions/CourseCoursesViewCreatedByL3","description":"Information for the user who created the cover"},"used_by_count":{"type":"integer","description":"The count of the items (Courses or Learning plans) that are using the image based on the image type. It holds the full count of the items and does not have any PU visibility filters."},"actions":{"description":"Possible actions on the cover image available to current user","enum":["edit","usage","copy_to_multidomain","download","delete"],"type":"string"}}},"CourseCoursesViewCreatedByL3":{"required":["id","username","firstname","lastname"],"properties":{"id":{"type":"integer","description":"ID of the creator user"},"username":{"type":"string","description":"Username of the creator user"},"firstname":{"type":"string","description":"First name of the creator user"},"lastname":{"type":"string","description":"Last name of the creator user"}}},"CourseCoursesViewHeaderLayout":{"required":["mode"],"properties":{"mode":{"description":"Header Layout mode","enum":["color","cover_image","basic"],"type":"string"},"color":{"type":"string","description":"Header Layout color. Only returned if header_layout.mode is &quot;color&quot;"}}},"CourseCoursesViewSkills":{"required":["id","esco_code","name"],"properties":{"id":{"type":"string","description":"ID of the skill"},"esco_code":{"type":"string","description":"Code of the skill"},"name":{"type":"string","description":"Name of the skill"}}},"CourseCoursesViewEsignature":{"required":["enabled","title","description"],"properties":{"enabled":{"type":"boolean","description":"ESignature status"},"title":{"type":"string","description":"ESignature title for the course"},"description":{"type":"string","description":"ESignature description for the course"}}},"CourseCoursesViewViltOptions":{"required":["course_completion"],"properties":{"course_completion":{"$ref":"#/definitions/CourseCoursesViewCourseCompletion","description":"Course completion options"}}},"CourseCoursesViewCourseCompletion":{"required":["mode","percentage"],"properties":{"mode":{"description":"Course completion mode","enum":["single_session","custom_count"],"type":"string"},"percentage":{"type":"integer","description":"Percentage of completed sessions. It has value only when the mode is &#039;custom_count&#039;. It can be null"}}},"CourseCoursesViewEnrollmentOptions":{"required":["self_unenrollment_mode","deeplink"],"properties":{"self_unenrollment_mode":{"description":"Self unenrollment mode.","enum":["enrolled_but_completed","enrolled_and_completed","null"],"type":"string"},"allow_self_session_unenrollment":{"type":"boolean","description":"Whether session unernrollment is allowed. Only returned for VILT Courses"},"allow_self_session_change":{"type":"boolean","description":"Whether session change is allowed. Only returned for VILT Courses"},"course_rsvp":{"type":"boolean","description":"Whether rsvp is active at course level. Only returned for VILT Courses"},"deeplink":{"$ref":"#/definitions/CourseCoursesViewDeeplink","description":"Course deeplink information"},"hide_attendees":{"type":"boolean","description":"Hide attendees. Only returned for VILT courses if toggle release/weekly/vilt-rsvp is enabled"},"enrollment_code":{"type":"string","description":"Enrollment code. Only returned if SubscriptionsCodes App is active. It can be null"},"enable_session_unenrolment_on_user_deactivated":{"type":"boolean","description":"If true when a user is deactivated he will be unenrolled from all the sessions to which he is enrolled. Only for classroom / ILT courses"},"quick_enrollment_enabled":{"type":"boolean","description":"Whether the quick enrollment is enabled for the course or not. Only returned for eLearning courses. It can be null"}}},"CourseCoursesViewDeeplink":{"required":["enabled","hash"],"properties":{"enabled":{"type":"boolean","description":"Whether deeplink is enabled"},"hash":{"type":"string","description":"Deeplink hash"}}},"CourseCoursesViewTimeOptions":{"required":["date_begin","date_end","duration","defaults"],"properties":{"date_begin":{"type":"string","format":"date","description":"Date begin of the course in format YYYY-MM-DD. It can be null"},"date_end":{"type":"string","format":"date","description":"Date end of the course in format YYYY-MM-DD. It can be null"},"duration":{"$ref":"#/definitions/CourseCoursesViewDuration","description":"Duration of the course. It can be null"},"soft_deadline":{"type":"boolean","description":"Soft deadline of the course. Only returned for eLearning courses. It can be null"},"defaults":{"$ref":"#/definitions/CourseCoursesViewDefaults","description":"Default time options settings"}}},"CourseCoursesViewDuration":{"required":["days"],"properties":{"days":{"type":"integer","description":"Duration days"},"trigger":{"description":"Only returned for eLearning courses","enum":["first_access","enrollment_creation"],"type":"string"}}},"CourseCoursesViewDefaults":{"properties":{"soft_deadline":{"type":"boolean","description":"Default soft deadline setting. Only returned for eLearning courses"}}},"CourseCoursesViewLoNavigation":{"required":["mode","max_attempts"],"properties":{"mode":{"description":"Learning object navigation mode","enum":["free","sequential","first_required","all_but_last_required"],"type":"string"},"max_attempts":{"type":"integer","description":"Maximum number of attempts. It can be null"}}},"CourseCoursesViewCoursePlayer":{"required":["landing_page","background_image","table_of_content","autoplay","lightbox_navigation","player_appearance","focus_mode","harmony_tutoring","defaults"],"properties":{"landing_page":{"description":"Course player landing page.","enum":["player","overview","null"],"type":"string"},"background_image":{"$ref":"#/definitions/CourseCoursesViewBackgroundImage","description":"Course background information"},"table_of_content":{"type":"boolean","description":"Whether the course player should display or not the table of content. It can be null"},"autoplay":{"type":"boolean","description":"Whether next chapter should be automatically played after the previous is completed. It can be null"},"lightbox_navigation":{"type":"boolean","description":"Whether the course player should display the &#039;Next&#039; and &#039;Previous&#039; buttons when using the Lightbox mode. It can be null"},"player_appearance":{"description":"Whether the new Course Player needs to be displayed in light or dark mode. It can be null","enum":["light","dark"],"type":"string"},"focus_mode":{"type":"boolean","description":"Whether the Focus Mode is enabled for this course. It can be null"},"harmony_tutoring":{"type":"boolean","description":"Whether the Harmony Tutoring is enabled for this course. It can be null"},"defaults":{"$ref":"#/definitions/CourseCoursesViewDefaultsL2","description":"Default course player configuration"}}},"CourseCoursesViewBackgroundImage":{"required":["image","mode"],"properties":{"image":{"$ref":"#/definitions/CourseCoursesViewImage","description":"Course background image information. It can be null"},"mode":{"description":"Preferred player background image stretch mode","enum":["adaptive","original_size"],"type":"string"}}},"CourseCoursesViewImage":{"required":["id","name","url","width","height","filesize","created_by","used_by_count","actions"],"properties":{"id":{"type":"integer","description":"Internal ID of the background image"},"name":{"type":"string","description":"Original file name (human friendly version)"},"url":{"type":"string","description":"S3 URL to the image resource"},"width":{"type":"integer","description":"Background image width in px"},"height":{"type":"integer","description":"Background image height in px"},"filesize":{"type":"integer","description":"Background image file size in bytes"},"created_by":{"$ref":"#/definitions/CourseCoursesViewCreatedByL4","description":"Information for the user who created the background image"},"used_by_count":{"type":"integer","description":"The count of the items (Courses or Learning plans) that are using the image based on the image type. It holds the full count of the items and does not have any PU visibility filters."},"actions":{"description":"Possible actions on the background image available to current user","enum":["edit","usage","copy_to_multidomain","download","delete"],"type":"string"}}},"CourseCoursesViewCreatedByL4":{"required":["id","username","firstname","lastname"],"properties":{"id":{"type":"integer","description":"ID of the creator user"},"username":{"type":"string","description":"Username of the creator user"},"firstname":{"type":"string","description":"First name of the creator user"},"lastname":{"type":"string","description":"Last name of the creator user"}}},"CourseCoursesViewDefaultsL2":{"required":["landing_page","background_image","table_of_content","autoplay","lightbox_navigation","player_appearance","focus_mode","harmony_tutoring"],"properties":{"landing_page":{"description":"Course player landing page","enum":["player","overview"],"type":"string"},"background_image":{"$ref":"#/definitions/CourseCoursesViewBackgroundImageL2","description":"Course background image information. It can be null"},"table_of_content":{"type":"boolean","description":"Whether the course player should display or not the table of content"},"autoplay":{"type":"boolean","description":"Whether next chapter should be automatically played after the previous is completed"},"lightbox_navigation":{"type":"boolean","description":"Whether the course player should display the &quot;Next&quot; and &quot;Previous&quot; buttons when using the Lightbox mode"},"player_appearance":{"description":"Whether the new Course Player needs to be displayed in light or dark mode","enum":["light","dark"],"type":"string"},"focus_mode":{"type":"boolean","description":"Whether the Focus Mode is enabled"},"harmony_tutoring":{"type":"boolean","description":"Whether the Harmony Tutoring is enabled"}}},"CourseCoursesViewBackgroundImageL2":{"required":["image","mode"],"properties":{"image":{"$ref":"#/definitions/CourseCoursesViewImageL2","description":"Course background image information. It can be null"},"mode":{"description":"Preferred player background image stretch mode","enum":["adaptive","original_size"],"type":"string"}}},"CourseCoursesViewImageL2":{"required":["url"],"properties":{"url":{"type":"string","description":"Background image URL"}}},"CourseCoursesViewCertificate":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of assigned certificate"},"name":{"type":"string","description":"Name of assigned certificate"},"additional_certificates":{"type":"array","description":"An array of additional certificate templates. Returned only if the toggle release/weekly/multiple-certificates-per-course is ON. Its value can be null","items":{"$ref":"#/definitions/CourseCoursesViewAdditionalCertificates"}},"additional_certificate_options":{"$ref":"#/definitions/CourseCoursesViewAdditionalCertificateOptions","description":"Course multiple certificates generation options."}}},"CourseCoursesViewAdditionalCertificates":{"required":["sequence","certificate","association_entity","associated_on"],"properties":{"sequence":{"type":"integer","description":"The sequence order of the certificate in the list of all additional certificates"},"certificate":{"$ref":"#/definitions/CourseCoursesViewCertificateL2","description":"An object with information for the additional certificate. Its value can be null for PU that does not have visibility over the certificate"},"association_entity":{"$ref":"#/definitions/CourseCoursesViewAssociationEntity","description":"An object with information for the associated entity. Its value can be null for PU that does not have visibility over the group/branch"},"associated_on":{"type":"string","format":"date","description":"Association date and time UTC in format YYYY-MM-DD hh:mm:ss"}}},"CourseCoursesViewCertificateL2":{"required":["id","code","name"],"properties":{"id":{"type":"integer","description":"ID of the additional certificate"},"code":{"type":"string","description":"Code of the additional certificate"},"name":{"type":"string","description":"Name of the additional certificate"}}},"CourseCoursesViewAssociationEntity":{"required":["id","type","name"],"properties":{"id":{"type":"integer","description":"ID of the associated entity"},"type":{"description":"Type of the associated entity","enum":["group","branch"],"type":"string"},"name":{"type":"string","description":"Name of the associated entity"}}},"CourseCoursesViewAdditionalCertificateOptions":{"required":["enable_multiple_certificates_generation","certificates_to_generate"],"properties":{"enable_multiple_certificates_generation":{"type":"boolean","description":"Enable the use of multiple certificates generation."},"certificates_to_generate":{"type":"integer","description":"The number of certificates that can be generated."}}},"CourseCoursesViewCatalogOptions":{"required":["mode","self_enrollment","waiting_list","enrollment_quota","demo_material_name"],"properties":{"mode":{"description":"Policy about course displaying in the catalogs","enum":["public","internal","enrolled"],"type":"string"},"self_enrollment":{"$ref":"#/definitions/CourseCoursesViewSelfEnrollment","description":"Self enrollment options"},"waiting_list":{"$ref":"#/definitions/CourseCoursesViewWaitingList","description":"Waiting list information"},"enrollment_quota":{"$ref":"#/definitions/CourseCoursesViewEnrollmentQuota","description":"Enrollment quota information. It can be null"},"demo_material_name":{"type":"string","description":"Demo material (file name). It can be null"}}},"CourseCoursesViewSelfEnrollment":{"required":["mode","start_date","end_date","policy"],"properties":{"mode":{"description":"Self enrollment mode","enum":["disabled","enabled","timeframe"],"type":"string"},"start_date":{"type":"string","format":"date","description":"Beginning of the enrollment period. YYYY-MM-DD. It can be null"},"end_date":{"type":"string","format":"date","description":"End of the enrollment period. YYYY-MM-DD. It can be null"},"policy":{"description":"Self enrollment policy. It returns &#039;only_admin&#039; when mode is &#039;disabled&#039;","enum":["only_admin","pending_admin","free"],"type":"string"}}},"CourseCoursesViewWaitingList":{"required":["enabled","automatic_enrollment"],"properties":{"enabled":{"type":"boolean","description":"Whether the waiting list is enabled"},"automatic_enrollment":{"type":"boolean","description":"Whether the waiting users will be automatically enrolled after enrolled user is unenrolled"}}},"CourseCoursesViewEnrollmentQuota":{"required":["limit"],"properties":{"limit":{"type":"integer","description":"Maximum enrolment quota (0 = no limit)"}}},"CourseCoursesViewEquivalentCourses":{"required":["course","mode"],"properties":{"course":{"$ref":"#/definitions/CourseCoursesViewCourse","description":"Equivalent course data. Can be null if the caller of the API is PU that doesn&#039;t have Visibility of that course"},"mode":{"description":"Relation mode","enum":["bidirectional","source","target"],"type":"string"}}},"CourseCoursesViewCourse":{"required":["id","code","name","type","status"],"properties":{"id":{"type":"integer","description":"Equivalent course ID"},"code":{"type":"string","description":"Equivalent course code"},"name":{"type":"string","description":"Equivalent course name"},"type":{"description":"Equivalent course type","enum":["elearning","classroom"],"type":"string"},"status":{"description":"Equivalent course status","enum":["published","under_maintenance"],"type":"string"}}},"CourseCoursesViewEcommerceOptions":{"required":["enabled","price","csp"],"properties":{"enabled":{"type":"boolean","description":"Whether this course is on sale (through the ecommerce functionality)"},"price":{"type":"integer","description":"The price of the course in cents of its currency. eg: 100 means the course costs 1. It can be null"},"prices":{"$ref":"#/definitions/CourseCoursesViewPrices","description":"The object that contains the course prices"},"affiliate_price":{"type":"integer","description":"Affiliate price. It is only returned if ContentPartner App is active and a content partner is set for the course. It can be null"},"csp":{"type":"boolean","description":"Whether this course contains at least one external learning object"}}},"CourseCoursesViewPrices":{"properties":{"currency_code":{"type":"number","description":"Price value. Replace currency_code with a ISO currency code or with the DTC (docebo training credits) currency code. The value should be a number."}}},"CourseCoursesViewContentPartner":{"required":["id","name","status","discount","additional_fields_enabled"],"properties":{"id":{"type":"integer","description":"ID of the content partner. It can be null"},"name":{"type":"string","description":"Name of the content partner. It can be null"},"status":{"description":"Status of the content partner.","enum":["active","inactive","null"],"type":"string"},"discount":{"type":"integer","description":"The amount of discount set to this partner"},"additional_fields_enabled":{"type":"boolean","description":"Indicate whether if the partner additional fields can be set for this course"},"additional_fields":{"type":"array","description":"Partner fields for the course, if any. Maximum number of objects: 10","items":{"$ref":"#/definitions/CourseCoursesViewAdditionalFields"}}}},"CourseCoursesViewAdditionalFields":{"required":["id","type","title","mandatory","value"],"properties":{"id":{"type":"integer","description":"ID of the field"},"type":{"description":"Type of the field","enum":["dropdown","textfield","date"],"type":"string"},"title":{"type":"string","description":"Title of the field"},"mandatory":{"type":"boolean","description":"Whether the field is mandatory or not"},"value":{"type":"string","description":"Value of the field. It can be an integer, string or null"},"options":{"type":"array","description":"Dropdown options. Only returned when the type of the field is dropdown","items":{"$ref":"#/definitions/CourseCoursesViewOptions"}}}},"CourseCoursesViewOptions":{"required":["id","label"],"properties":{"id":{"type":"integer","description":"ID of the dropdown option"},"label":{"type":"string","description":"Label of the dropdown option"}}},"CourseCoursesViewRating":{"required":["enabled","mode","defaults"],"properties":{"enabled":{"type":"boolean","description":"Whether course rating is enabled for the course or not"},"mode":{"description":"Course rating mode.","enum":["disabled","public","enrolled","completed","null"],"type":"string"},"defaults":{"$ref":"#/definitions/CourseCoursesViewDefaultsL3","description":"Default rating options"}}},"CourseCoursesViewDefaultsL3":{"required":["mode"],"properties":{"mode":{"description":"Rating mode","enum":["disabled","public","enrolled","completed"],"type":"string"}}},"CourseCoursesViewSocialSharing":{"required":["enabled","mode","networks","share_score","defaults"],"properties":{"enabled":{"type":"boolean","description":"Whether course sharing is enabled for the course or not"},"mode":{"description":"Course sharing mode.","enum":["disabled","enrolled","completed","null"],"type":"string"},"networks":{"type":"array","description":"Course sharing network. Can be &#039;twitter&#039;, &#039;linkedin&#039;. It can be null","items":{"type":"string"}},"share_score":{"type":"boolean","description":"Whether score sharing is enabled or not. It can be null"},"defaults":{"$ref":"#/definitions/CourseCoursesViewDefaultsL4","description":"Default sharing options"}}},"CourseCoursesViewDefaultsL4":{"required":["mode","networks","share_score"],"properties":{"mode":{"description":"Sharing mode","enum":["disabled","enrolled","completed"],"type":"string"},"networks":{"type":"array","description":"Sharing network. Can be &#039;twitter&#039;, &#039;linkedin&#039;","items":{"type":"string"}},"share_score":{"type":"boolean","description":"Whether score sharing is enabled or not"}}},"CourseCoursesViewScoreOptions":{"required":["initial_score_lo","final_score"],"properties":{"initial_score_lo":{"$ref":"#/definitions/CourseCoursesViewInitialScoreLo","description":"Data for the initial learning object. It can be null"},"final_score":{"$ref":"#/definitions/CourseCoursesViewFinalScore","description":"Course final score options"}}},"CourseCoursesViewInitialScoreLo":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of the initial learning object"},"name":{"type":"string","description":"Name of the initial learning object"}}},"CourseCoursesViewFinalScore":{"required":["calculation_mode","specific_lo"],"properties":{"calculation_mode":{"description":"Final score calculation mode","enum":["last_lo","specific_lo","sum_los","average_los"],"type":"string"},"specific_lo":{"$ref":"#/definitions/CourseCoursesViewSpecificLo","description":"Data for the final learning object. It can be null"}}},"CourseCoursesViewSpecificLo":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of the final learning object"},"name":{"type":"string","description":"Name of the final learning object"}}},"CourseCoursesViewCertification":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of assigned certification"},"name":{"type":"string","description":"Name of assigned certification"}}},"CourseCoursesViewSeoOptions":{"properties":{"meta_description":{"type":"string","description":"Seo meta description content. Can be null"},"redirect_to":{"type":"string","description":"Redirect the user to this url when visit the course page"},"custom_slug":{"type":"string","description":"Custom slug for the course url"}}},"CourseCoursesViewProctoring":{"required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"True when at least one Test Training Material with the proctoring activated inside the course."}}},"CourseCoursesViewMultiLanguages":{"required":["code","name","browser_code"],"properties":{"code":{"type":"string","description":"Code of the course language"},"name":{"type":"string","description":"Name of the course language"},"browser_code":{"type":"string","description":"Browser code (2 characters) of the course language"}}},"CourseCoursesViewUpdateData":{"required":["updated_by","updated_at"],"properties":{"updated_by":{"$ref":"#/definitions/CourseCoursesViewUpdatedBy","description":"Information for the user who created course. Its value can be null"},"updated_at":{"type":"string","format":"date","description":"Course last update date and time UTC"}}},"CourseCoursesViewUpdatedBy":{"required":["id","fullname"],"properties":{"id":{"type":"integer","description":"The ID of the user who updated the course"},"fullname":{"type":"string","description":"Full name of the user who updated the course"}}},"CourseCoursesViewCourseInformationTranslations":{"required":["lang_code","name","description","short_description","source"],"properties":{"lang_code":{"type":"string","description":"Language code of the translation"},"name":{"type":"string","description":"Translated course title"},"description":{"type":"string","description":"Translated course description"},"short_description":{"type":"string","description":"Translated short course description. It can be null"},"source":{"type":"string","description":"Source of the translation (e.g. as_default, manual)"}}},"CourseCoursesViewExtraData":{"required":["enrollment"],"properties":{"enrollment":{"$ref":"#/definitions/CourseCoursesViewEnrollment","description":"An object with enrollment data. It can be null"}}},"CourseCoursesViewEnrollment":{"required":["level"],"properties":{"level":{"description":"Enrollment level for this user in the course","enum":["learner","instructor","tutor"],"type":"string"}}},"CourseCoursesViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCoursesViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesViewLast","description":"Link to the last page"}}},"CourseCoursesViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesSeatsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesSeatsData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesSeatsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesSeatsData":{"required":["items"],"properties":{"items":{"type":"array","description":"API result: Assigned power users to this course and their information","items":{"$ref":"#/definitions/CourseCoursesSeatsItems"}}}},"CourseCoursesSeatsItems":{"required":["avatar","id","email","username","firstname","lastname","used_seats","purchased_seats","extra_seats","total_seats"],"properties":{"avatar":{"type":"string","description":"Avatar URL of the user"},"id":{"type":"integer","description":"Internal ID of the user"},"email":{"type":"string","description":"E-mail address of the user"},"username":{"type":"string","description":"Username of the user"},"firstname":{"type":"string","description":"First name of the user"},"lastname":{"type":"string","description":"Last name of the user"},"used_seats":{"type":"integer","description":"Number of used seats for this course"},"purchased_seats":{"type":"integer","description":"Number of purchased seats for this course"},"extra_seats":{"type":"integer","description":"Number of given extra seats for this course, by administrator"},"total_seats":{"type":"integer","description":"Total number of the seats for this course"}}},"CourseCoursesSeatsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesSeatsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCoursesSeatsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesSeatsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesSeatsLast","description":"Link to the last page"}}},"CourseCoursesSeatsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesSeatsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesSeatsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesSeatsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects with course properties that need to be updated","items":{"$ref":"#/definitions/CourseCoursesBatchItems"}}}},"CourseCoursesBatchItems":{"required":["id"],"properties":{"id":{"type":"integer","description":"Internal ID of the course, that need to be updated"},"code":{"type":"string","description":"The new code of the course"},"title":{"type":"string","description":"The new name of the course"},"description":{"type":"string","description":"The new description of the course"},"language":{"type":"string","description":"The new language of the course. Format browser_code: en, it, bg..."},"multilanguage_codes":{"type":"array","description":"The list of additional language codes for this course (usable only with the course multilanguage feature). If the multilanguage feature is active and language is passed, this field is mandatory. It can be NULL or empty array (multilanguage inactive/deactivated), or an array of language strings, written in the same format as the language parameter.","items":{"type":"string"}},"course_status":{"description":"Course status","enum":["published","unpublished"],"type":"string"},"category_id":{"type":"integer","description":"ID of the course category"},"category_code":{"type":"integer","description":"Code of the category of the course. Used if “category_id” is not provided"},"thumbnail_id":{"type":"integer","description":"ID thumbnail of the course. If the user is PU, then it should have “course/thumbnail/manage” permission"},"batch_item_id":{"type":"string","description":"This will be returned as it is in the output. It&#039;s not course data, but may be useful in some processes"}}},"CourseCoursesBatchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/CourseCoursesBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/CourseCoursesBatchLinks"}}}},"CourseCoursesBatchData":{"required":["row_index","success"],"properties":{"row_index":{"type":"integer","description":"Update ID for the current record"},"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Optional error message"},"output":{"$ref":"#/definitions/CourseCoursesBatchOutput","description":"An output object"}}},"CourseCoursesBatchOutput":{"properties":{"id":{"type":"integer","description":"Updated course ID in the LMS"},"batch_item_id":{"type":"string","description":"User specified ID for single batch item, passed in input parameters"}}},"CourseCoursesBatchLinks":{},"CourseCoursesAddSeatsSchema":{"type":"object","required":["extra_seats"],"properties":{"extra_seats":{"type":"integer","description":"Extra seats, that will be assigned to the Power User"}}},"CourseCoursesAddSeatsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response","items":{"$ref":"#/definitions/CourseCoursesAddSeatsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesAddSeatsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesAddSeatsData":{},"CourseCoursesAddSeatsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesAddSeatsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCoursesAddSeatsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesAddSeatsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesAddSeatsLast","description":"Link to the last page"}}},"CourseCoursesAddSeatsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesAddSeatsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesAddSeatsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesAddSeatsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesUpdateSeatsSchema":{"type":"object","required":["extra_seats"],"properties":{"extra_seats":{"type":"integer","description":"Extra seats, that will be assigned to the Power User"}}},"CourseCoursesUpdateSeatsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response","items":{"$ref":"#/definitions/CourseCoursesUpdateSeatsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesUpdateSeatsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesUpdateSeatsData":{},"CourseCoursesUpdateSeatsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesUpdateSeatsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCoursesUpdateSeatsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesUpdateSeatsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesUpdateSeatsLast","description":"Link to the last page"}}},"CourseCoursesUpdateSeatsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesUpdateSeatsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesUpdateSeatsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesUpdateSeatsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesEnrollableUsersResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesEnrollableUsersData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesEnrollableUsersLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesEnrollableUsersData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of users","items":{"$ref":"#/definitions/CourseCoursesEnrollableUsersItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesEnrollableUsersItems":{"required":["user_id","username","first_name","last_name","email"],"properties":{"user_id":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email address of the user"},"is_suggested":{"type":"boolean","description":"Is user suggested by AI"}}},"CourseCoursesEnrollableUsersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesEnrollableUsersSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCoursesEnrollableUsersGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesEnrollableUsersFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesEnrollableUsersLast","description":"Link to the last page"}}},"CourseCoursesEnrollableUsersSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesEnrollableUsersGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesEnrollableUsersFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesEnrollableUsersLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesSignSchema":{"type":"object","required":["identifier"],"properties":{"identifier":{"description":"","enum":["email","authenticatorapp"],"type":"string"},"otp":{"type":"string","description":"otp or recovery_code is required"},"recovery_code":{"type":"string","description":"otp or recovery_code is required"}}},"CourseCoursesSignResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesSignData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesSignData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"recovery_code":{"type":"string","description":"The new recovery code"},"message":{"type":"boolean","description":"Message in case of failure"}}},"CourseCoursesDuplicateSchema":{"type":"object","required":["course_name"],"properties":{"course_name":{"type":"string","description":"New name of the duplicated course"},"duplicate_materials":{"type":"boolean","description":"Flag to duplicated also course training materials. Default: false. Not compatible with e-learning courses with the multi-language feature set and configured."},"duplicate_widgets":{"type":"boolean","description":"Flag to duplicate also course widgets. Default: false"},"duplicate_enrollments":{"type":"boolean","description":"Flag to duplicate also all course enrollments. Default: false"},"mandatory_additional_fields":{"$ref":"#/definitions/CourseCoursesDuplicateMandatoryAdditionalFields","description":"List of mandatory additional fields which will override the values of the ones inherited by the course being cloned. This list becomes mandatory only if there are mandatory additional fields configured for courses and the course being cloned does not have some or all of them set"}}},"CourseCoursesDuplicateMandatoryAdditionalFields":{"required":["xxx"],"properties":{"xxx":{"type":"string","description":"First mandatory additional field to be provided (if present becomes required). Multiple additional fields may be added. Simply replace &quot;xxx&quot; with the ID of the additional field. The value may be an integer (e.g. for Dropdown additional fields), a string (Text additional field, Textarea additional field), or an array of positive integers (dropdown option IDs) for Multi-value Dropdown additional fields when toggle release/weekly/multi-value-dropdown-additional-field is ON. If that toggle is OFF, an array for a multi-value dropdown field is rejected."}}},"CourseCoursesDuplicateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesDuplicateData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesDuplicateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesDuplicateData":{"required":["success","course_id"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"course_id":{"type":"integer","description":"Internal ID of the duplicated course"}}},"CourseCoursesDuplicateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesDuplicateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCoursesDuplicateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesDuplicateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesDuplicateLast","description":"Link to the last page"}}},"CourseCoursesDuplicateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesDuplicateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesDuplicateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesDuplicateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesGetCatalogsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetCatalogsData","description":"Catalogs listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesGetCatalogsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of catalogs","items":{"$ref":"#/definitions/CourseCoursesGetCatalogsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesGetCatalogsItems":{"required":["id","name","description"],"properties":{"id":{"type":"integer","description":"ID of the catalog"},"name":{"type":"string","description":"Catalog name"},"description":{"type":"string","description":"Catalog description"},"code":{"type":"string","description":"Catalog code"}}},"CourseCoursesGetLearningPlansResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetLearningPlansData","description":"Learning plans listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesGetLearningPlansData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of learning plans","items":{"$ref":"#/definitions/CourseCoursesGetLearningPlansItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesGetLearningPlansItems":{"required":["id_path","path_name","path_description","is_required","is_last_mandatory","is_published"],"properties":{"id_path":{"type":"integer","description":"ID of the learning plan"},"path_name":{"type":"string","description":"Learning plan name"},"path_description":{"type":"string","description":"Catalog description"},"path_code":{"type":"string","description":"Learning plan code"},"thumbnail":{"type":"string","description":"The path of the thumbnail"},"is_required":{"type":"boolean","description":"Returns TRUE if the course is required in the learning plan, if is optional it returns FALSE"},"is_last_mandatory":{"type":"boolean","description":"Returns TRUE if the course is the last mandatory one of the learning plan"},"is_published":{"type":"boolean","description":"Returns TRUE if the learning plan is published (FALSE if under maintenance)"},"type":{"description":"Candidate type. Present only when New Certification feature is enabled","enum":["learningplan","certification"],"type":"string"}}},"CourseCoursesDeleteLearningPlansResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesDeleteLearningPlansData","description":"Response empty array"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesDeleteLearningPlansData":{},"CourseCoursesPostAssignLearningPlansSchema":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","description":"Integer array of learning plans to be assigned","items":{"type":"integer"}},"courses_optional":{"type":"array","description":"Integer array of learning plans to be assigned where the course is set as optional","items":{"type":"integer"}}}},"CourseCoursesPostAssignLearningPlansResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesPostAssignLearningPlansData","description":"Response empty array"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesPostAssignLearningPlansData":{},"CourseCoursesGetLearningPlansCandidatesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetLearningPlansCandidatesData","description":"Learning plans listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesGetLearningPlansCandidatesData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of learning plans","items":{"$ref":"#/definitions/CourseCoursesGetLearningPlansCandidatesItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesGetLearningPlansCandidatesItems":{"required":["id_path","path_name","path_description","is_required"],"properties":{"id_path":{"type":"integer","description":"ID of the learning plan"},"path_name":{"type":"string","description":"Learning plan name"},"path_description":{"type":"string","description":"Catalog description"},"path_code":{"type":"string","description":"Learning plan code"},"associated":{"type":"boolean","description":"True if the learning plan is associated to given course"},"is_required":{"type":"boolean","description":"Returns TRUE if the course is required in the learning plan, if is optional it returns FALSE. Default TRUE"},"thumbnail":{"type":"string","description":"The path of the thumbnail"},"type":{"description":"Candidate type. Present only when New Certification feature is enabled","enum":["learningplan","certification"],"type":"string"}}},"CourseCoursesGetChannelsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetChannelsData","description":"Channels listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesGetChannelsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"Array of Channels","items":{"$ref":"#/definitions/CourseCoursesGetChannelsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesGetChannelsItems":{"required":["id","icon_fa","icon_color","icon_bgr","name","description"],"properties":{"id":{"type":"integer","description":"ID of the channel"},"icon_fa":{"type":"string","description":"icon font-awesome class"},"icon_color":{"type":"string","description":"icon color"},"icon_bgr":{"type":"string","description":"icon background color"},"name":{"type":"string","description":"Channel name"},"description":{"type":"string","description":"Channel description"}}},"CourseCoursesDeleteChannelAssociationResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesDeleteChannelAssociationData","description":"Response empty array"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesDeleteChannelAssociationData":{},"CourseCoursesPostChannelsSchema":{"type":"object","required":["assignments"],"properties":{"assignments":{"type":"array","description":"Integer array of channels to be assigned","items":{"type":"integer"}}}},"CourseCoursesPostChannelsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesPostChannelsData","description":"Response empty array"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesPostChannelsData":{},"CourseCoursesGetChannelsCandidatesResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetChannelsCandidatesData","description":"Channels listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesGetChannelsCandidatesData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of Channels","items":{"$ref":"#/definitions/CourseCoursesGetChannelsCandidatesItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesGetChannelsCandidatesItems":{"required":["id","icon_fa","icon_color","associated"],"properties":{"id":{"type":"integer","description":"ID of the channel"},"icon_fa":{"type":"string","description":"icon font-awesome class"},"icon_color":{"type":"string","description":"icon color"},"icon_bgr":{"type":"string","description":"icon background color"},"name":{"type":"string","description":"Channel name"},"description":{"type":"string","description":"Channel description"},"associated":{"type":"integer","description":"Shows if channel is associated to given course"}}},"CourseCoursesGetEnrollmentsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetEnrollmentsData","description":"Enrollments listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesGetEnrollmentsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"Array of Enrollments","items":{"$ref":"#/definitions/CourseCoursesGetEnrollmentsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesGetEnrollmentsItems":{"required":["user_id","username","email","first_name","last_name","level","enrollment_date","active_from","active_until","status","status_id","level_id","user_status_id","user_status"],"properties":{"user_id":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"email":{"type":"string","description":"Email of enrolled user"},"first_name":{"type":"string","description":"First name of enrolled user"},"last_name":{"type":"string","description":"Last name of enrolled user"},"level":{"type":"string","description":"Level of enrolled user"},"enrollment_date":{"type":"string","format":"date","description":"Date of enrollment"},"active_from":{"type":"string","format":"date","description":"Active from date"},"active_until":{"type":"string","format":"date","description":"Active until date"},"status":{"type":"string","description":"Status of enrollment"},"status_id":{"type":"integer","description":"ID of enrollment status"},"level_id":{"type":"integer","description":"ID of user level"},"user_status_id":{"type":"integer","description":"Id of status of user"},"user_status":{"type":"string","description":"Status of user"},"score_given":{"type":"integer","description":"Score of the user"},"forced_score_given":{"type":"boolean","description":"Indicates if score has been set by admin"},"date_complete":{"type":"string","format":"date","description":"Date of course completion"},"enrollment_sessions":{"type":"integer","description":"Total number of session the user is enrolled in"},"assignment_type":{"description":"Enrollment assignment type for the user. It can be null.","enum":["mandatory","required","recommended","optional"],"type":"string"},"branches":{"type":"array","description":"Array of Branches, only present if requested by passing &#039;branches&#039; to the extra_fields parameter","items":{"$ref":"#/definitions/CourseCoursesGetEnrollmentsBranches"}}}},"CourseCoursesGetEnrollmentsBranches":{"properties":{"id":{"type":"integer","description":"ID of the Branch"},"name":{"type":"string","description":"Name of the Branch"},"path":{"type":"array","description":"Array with Names of parents Branches","items":{"$ref":"#/definitions/CourseCoursesGetEnrollmentsPath"}}}},"CourseCoursesGetEnrollmentsPath":{},"CourseCoursesPutBatchStatusSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Integer array of courses to be updated","items":{"$ref":"#/definitions/CourseCoursesPutBatchStatusItems"}}}},"CourseCoursesPutBatchStatusItems":{"required":["id"],"properties":{"id":{"type":"integer","description":"Course id"}}},"CourseCoursesPutBatchStatusResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesPutBatchStatusData","description":"Response of each course"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesPutBatchStatusData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of operation status","items":{"$ref":"#/definitions/CourseCoursesPutBatchStatusItemsL2"}}}},"CourseCoursesPutBatchStatusItemsL2":{"required":["row_index","success","message"],"properties":{"row_index":{"type":"integer","description":"Progressive number of the array item"},"success":{"type":"boolean","description":"Status of operation, true if update works, false if cannot succeed"},"message":{"type":"string","description":"Message which describes the success true/false"}}},"CourseCoursesPutBatchThumbnailSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Integer array of courses to be update","items":{"$ref":"#/definitions/CourseCoursesPutBatchThumbnailItems"}}}},"CourseCoursesPutBatchThumbnailItems":{"required":["id"],"properties":{"id":{"type":"integer","description":"Course id"}}},"CourseCoursesPutBatchThumbnailResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesPutBatchThumbnailData","description":"Response of each course"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesPutBatchThumbnailData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of operation updated","items":{"$ref":"#/definitions/CourseCoursesPutBatchThumbnailItemsL2"}}}},"CourseCoursesPutBatchThumbnailItemsL2":{"required":["row_index","success","message"],"properties":{"row_index":{"type":"integer","description":"Progressive number of the array item"},"success":{"type":"boolean","description":"Status of operation, true if update works, false if cannot succeed"},"message":{"type":"string","description":"Message which describes the success true/false"}}},"CourseCoursesListSessionsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesListSessionsData","description":"Session listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesListSessionsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"Array of Sessions","items":{"$ref":"#/definitions/CourseCoursesListSessionsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesListSessionsItems":{"required":["id","code","name","date_start","date_end","hours","events","events_with_sync_failed","instructors","instructors_emails_number","waiting","enrolled","max_enroll","created_by","uid_session","externally_managed","additional_fields","location","attendance_type","attendance_details"],"properties":{"id":{"type":"integer","description":"ID of the session"},"migrated_webinar_session_id":{"type":"integer","description":"ID of the webinar session mapped to this ilt session (will be returned if migrated from a webinar course)"},"code":{"type":"string","description":"Code of the session"},"name":{"type":"string","description":"Name of the session"},"date_start":{"type":"string","description":"Start date of the session"},"date_end":{"type":"string","description":"End date of the session"},"hours":{"type":"string","description":"Duration in hours of the session"},"events":{"type":"integer","description":"Number of events"},"events_with_sync_failed":{"type":"integer","description":"Number of events with synchronization issues. In case of events with multiple sync issues, it is counted as 1 single event (Types of issues: Events with Video Conference Tool not synched or Events with External Calendar sync issues)"},"instructors":{"type":"integer","description":"Number of instructors"},"instructors_emails_number":{"type":"integer","description":"Number of instructors with email"},"waiting":{"type":"integer","description":"Number of users in waiting list"},"enrolled":{"type":"integer","description":"Number of users enrolled"},"max_enroll":{"type":"integer","description":"Max number of enrollable users"},"created_by":{"type":"string","description":"User that created the session"},"uid_session":{"type":"string","description":"Unique ID of the session"},"externally_managed":{"type":"boolean","description":"This field indicates if the ilt session is managed with Training Orchestra"},"additional_fields":{"type":"array","description":"Additional fields of the session","items":{"$ref":"#/definitions/CourseCoursesListSessionsAdditionalFields"}},"location":{"$ref":"#/definitions/CourseCoursesListSessionsLocation","description":"It&#039;s null when there are no onsite/flexibe events"},"attendance_type":{"type":"string","description":"Session attendance type"},"attendance_details":{"$ref":"#/definitions/CourseCoursesListSessionsAttendanceDetails","description":"Event count based on attendance type"}}},"CourseCoursesListSessionsAdditionalFields":{"required":["id","name","value"],"properties":{"id":{"type":"integer","description":"Id of the additional field"},"name":{"type":"string","description":"Name of the additional field"},"value":{"type":"string","description":"Value of the additional field"},"option_id":{"type":"integer","description":"Id of the option for the dropdown field"}}},"CourseCoursesListSessionsLocation":{"required":["count","id","name"],"properties":{"count":{"type":"integer","description":"Count of distinct venues among all the onsite/flexible events of the session"},"id":{"type":"integer","description":"Location id (has a value when location.count = 1, null otherwise)"},"name":{"type":"string","description":"Location name (has a value when location.count = 1, null otherwise)"},"address":{"type":"string","description":"Location address (has a value when location.count = 1, null otherwise)"}}},"CourseCoursesListSessionsAttendanceDetails":{"required":["online","onsite","flexible"],"properties":{"online":{"type":"integer","description":"Number of events available online"},"onsite":{"type":"integer","description":"Number of events available onsite"},"flexible":{"type":"integer","description":"Number of events available both online and onsite"}}},"CourseCoursesNewSessionSchema":{"type":"object","properties":{"instructors":{"type":"array","description":"Internal ID of the Instructors (must be a valid id, must not exceed 200 maximum assignable instructors)","items":{"type":"integer"}},"additional_fields":{"type":"array","description":"Additional fields value. For &quot;date&quot; type the date format should be &quot;yyyy-mm-dd&quot;","items":{"$ref":"#/definitions/CourseCoursesNewSessionAdditionalFields"}},"name":{"type":"string","description":"Name of the session"},"code":{"type":"string","description":"Code to identify the session"},"description":{"type":"string","description":"Description of the session"},"min_enroll":{"type":"integer","description":"Minimum number of enrollable users (must be greater than or equal to zero)"},"max_enroll":{"type":"integer","description":"Maximum number of enrollable users (must be greater than zero and min_enroll)"},"score_base":{"type":"integer","description":"Evaluation score base (must be greater than zero, is optional for every other evaluation_type but is mandatory and can only be used with evaluation_type = 0)"},"enrollment_deadline":{"type":"string","description":"The deadline for the learner to self enroll in the session. The date format should be &quot;yyyy-mm-dd&quot; (must be passed without custom_deadline_days)"},"custom_deadline_days":{"type":"integer","description":"The number of days before the session start date the learner can self enroll into the session (must be passed without enrollment_deadline)"},"evaluation_type":{"type":"integer","description":"Evaluation type (0: based on score, 1: based on test, 2: based on attendance dates, 3: manual)"},"min_attended_dates_for_completion":{"type":"integer","description":"The minimum number of events users have to attend in a session to mark it as completed (must greater than zero, can only be used with evaluation_type = 2)"},"custom_rsvp_enabled":{"type":"boolean","description":"Check for enable/disable custom option for the rsvp into session. When set, this overrides the course one (when the RSVP toggle is OFF this parameter will be ignored). Allowed values: null, false, true. Default value is null"}},"required":["name","max_enroll","evaluation_type"]},"CourseCoursesNewSessionAdditionalFields":{"properties":{"id":{"type":"integer","description":"Internal ID of the field"},"value":{"type":"string","description":"Value of the field"}}},"CourseCoursesNewSessionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesNewSessionData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesNewSessionData":{"required":["id_session"],"properties":{"id_session":{"type":"integer","description":"Result of the request"}}},"CourseCoursesGetCoursesEnrollmentsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsData","description":"Courses listing API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesGetCoursesEnrollmentsData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of all retrieved enrollments","items":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"Page index number of the current page (starting from 1)"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages"},"total_count":{"type":"integer","description":"Total number of items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsSort"}}}},"CourseCoursesGetCoursesEnrollmentsItems":{"required":["user_id","username","course_id","course_uid","course_code","course_name","course_type","course_begin_date","course_end_date","enrollment_level","enrollment_status","enrollment_create_by","enrollment_created_at","enrollment_validity_begin_date","enrollment_validity_end_date","enrollment_validity_begin_datetime","enrollment_validity_end_datetime","enrollment_date_last_updated","enrollment_completion_date","enrollment_score"],"properties":{"user_id":{"type":"integer","description":"Numeric ID of the enrolled user"},"username":{"type":"string","description":"Username of the enrolled user"},"course_id":{"type":"integer","description":"Numeric ID of the course in which the user is enrolled"},"course_uid":{"type":"string","description":"Unique ID of the course in which the user is enrolled"},"course_code":{"type":"string","description":"Code of the course in which the user is enrolled"},"course_name":{"type":"string","description":"Name of the course in which the user is enrolled"},"course_type":{"description":"Type of the course in which the user is enrolled","enum":["elearning","classroom"],"type":"string"},"course_begin_date":{"type":"string","format":"date","description":"Baginning of course availability period"},"course_end_date":{"type":"string","format":"date","description":"End of course availability period"},"enrollment_level":{"description":"Enrollment level of the user","enum":["student","instructor","tutor"],"type":"string"},"enrollment_status":{"description":"Enrollment status in the course","enum":["enrolled","in_progress","completed","subscription_to_confirm","waiting","suspended","overbooking"],"type":"string"},"enrollment_create_by":{"type":"integer","description":"Numeric ID of the user who performed the action of enrolling"},"enrollment_created_at":{"type":"string","format":"date","description":"Date and time of enrollment creation (UTC timezone)"},"enrollment_validity_begin_date":{"type":"string","format":"date","description":"Starting date of the enrollment validity period"},"enrollment_validity_end_date":{"type":"string","format":"date","description":"Ending date of the enrollment validity period"},"enrollment_validity_begin_datetime":{"type":"string","format":"date","description":"Starting date and time of the enrollment validity period"},"enrollment_validity_end_datetime":{"type":"string","format":"date","description":"Ending date and time of the enrollment validity period"},"enrollment_date_last_updated":{"type":"string","format":"date","description":"Date and time of the last update action on the enrollment (UTC timezone)"},"enrollment_completion_date":{"type":"string","format":"date","description":"Date and time of the course completion (UTC timezone)"},"enrollment_score":{"type":"number","format":"float","description":"Score obtained in the course"},"enrollment_time_spent":{"type":"integer","description":"Total time in seconds that the enrolled user has spent while attending the course. It will be showed only if requested in input parameters"},"assignment_type":{"description":"Assignment Type enrollment attribute. The possible values are &quot;mandatory&quot;, &quot;required&quot;, &quot;recommended&quot;, &quot;optional&quot;.","enum":["mandatory","required","recommended","optional"],"type":"string"}}},"CourseCoursesGetCoursesEnrollmentsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"Sorting field name"},"sort_dir":{"type":"string","description":"Sorting direction: asc = ascending, desc = descending"}}},"CourseCoursesGetCoursesEnrollmentsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsSelf","description":"Link to the current page"},"next":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsNext","description":"Link to the next page"},"prev":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsPrev","description":"Link to the previous page"},"goto":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesGetCoursesEnrollmentsLast","description":"Link to the last page"}}},"CourseCoursesGetCoursesEnrollmentsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesGetCoursesEnrollmentsNext":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the next page"}}},"CourseCoursesGetCoursesEnrollmentsPrev":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the previous page"}}},"CourseCoursesGetCoursesEnrollmentsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesGetCoursesEnrollmentsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesGetCoursesEnrollmentsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesPostAdditionalFieldsSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"An array of objects with additional fields data to be stored. Maximum 100 per batch","items":{"$ref":"#/definitions/CourseCoursesPostAdditionalFieldsItems"}}}},"CourseCoursesPostAdditionalFieldsItems":{"required":["id"],"properties":{"id":{"type":"integer","description":"The ID of the additional field"}}},"CourseCoursesPostAdditionalFieldsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Array of processed additional fields","items":{"$ref":"#/definitions/CourseCoursesPostAdditionalFieldsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS","items":{"$ref":"#/definitions/CourseCoursesPostAdditionalFieldsLinks"}}}},"CourseCoursesPostAdditionalFieldsData":{"required":["row_index","success","message","output"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of operation"},"message":{"type":"string","description":"Returned additional info for the status of the operation"},"output":{"type":"array","description":"Optional key value object for output","items":{"$ref":"#/definitions/CourseCoursesPostAdditionalFieldsOutput"}}}},"CourseCoursesPostAdditionalFieldsOutput":{},"CourseCoursesPostAdditionalFieldsLinks":{},"CourseCoursesGetLosAssignmentsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesGetLosAssignmentsData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of training material of type “assignment” present in the course","items":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and pre-built navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page. (You can set the number of items returned in each page using the appropriate setting in the LMS Advanced Settings)"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of items"}}},"CourseCoursesGetLosAssignmentsItems":{"required":["id","name","attempts"],"properties":{"id":{"type":"integer","description":"The ID of the training material of type “assignment”"},"name":{"type":"string","description":"The title of the assignment training material given by the admin"},"attempts":{"type":"integer","description":"Total number of users who have uploaded files for this training material"}}},"CourseCoursesGetLosAssignmentsLinks":{"required":["self","next","prev","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsSelf","description":"Link to the current page"},"next":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsNext","description":"Link to the next page"},"prev":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsPrev","description":"Link to the previous page"},"goto":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentsLast","description":"Link to the last page"}}},"CourseCoursesGetLosAssignmentsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesGetLosAssignmentsNext":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the next page"}}},"CourseCoursesGetLosAssignmentsPrev":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the previous page"}}},"CourseCoursesGetLosAssignmentsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesGetLosAssignmentsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesGetLosAssignmentsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesGetLosAssignmentAttemptsResponse":{"required":["data","version","extra_data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsExtraData","description":"Object that contains extra information"},"_links":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesGetLosAssignmentAttemptsData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"The list of attempts","items":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"cursor":{"type":"string","description":"Generate and return &quot;cursor&quot; and prebuilt navigational &quot;_links&quot;. Default is 0"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseCoursesGetLosAssignmentAttemptsItems":{"required":["id","type","name","submitted_on","files","submitted_by","evaluation_status"],"properties":{"id":{"type":"integer","description":"The attempt ID"},"type":{"type":"string","description":"The type of assignment uploaded. It can be either “upload” (if the uploaded item is a file) or “link” (if the assignment is a youtube, vimeo or wistia link)."},"name":{"type":"string","description":"The name of the assignment given by the user"},"comment":{"type":"string","description":"The comment given by the user when submitting the attempt. It can be null"},"submitted_on":{"type":"string","description":"The date when the last assignment upload attempt was made (i.e. the date when the last file was uploaded. Should the user replace the file, this parameter will show the date when the last attempt was made.)"},"files":{"type":"array","description":"The list of files (pre-signed urls) uploaded in the attempt","items":{"type":"string"}},"submitted_by":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsSubmittedBy","description":"Object that contains data about who submitted the attempt"},"evaluation_status":{"description":"The evaluation status of the attempts. The status is “pending” when the attempt is waiting for evaluation, “accepted” if it’s been marked as “passed by the evaluator”, “rejected” if it’s been marked as failed by the evaluator.","enum":["pending","accepted","rejected"],"type":"string"},"evaluation_data":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsEvaluationData","description":"Information about the evaluation of the assignment attempt"}}},"CourseCoursesGetLosAssignmentAttemptsSubmittedBy":{"required":["id","username"],"properties":{"id":{"type":"integer","description":"The ID of the user who submitted the attempt"},"username":{"type":"string","description":"The username of the user who submitted the attempt"}}},"CourseCoursesGetLosAssignmentAttemptsEvaluationData":{"properties":{"score":{"type":"integer","description":"The score (0-100) given to the last attempt by the evaluator"},"date":{"type":"string","format":"date","description":"Date when the attempt was last evaluated (i.e. the date when the last file was evaluated. Should the user replace the file, this parameter will show the date when the last evaluation was made.)"},"comment":{"type":"string","description":"The comment provided by the evaluator upon attempt evaluation"},"file":{"type":"string","description":"The list of files (pre-signed urls) uploaded by the evaluator upon attempt evaluation. It may return null in case no file was uploaded."},"evaluated_by":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsEvaluatedBy","description":"Object that contains data about who evaluated the attempt"}}},"CourseCoursesGetLosAssignmentAttemptsEvaluatedBy":{"required":["id","username"],"properties":{"id":{"type":"integer","description":"The ID of the evaluator (user who evaluated the attempt)"},"username":{"type":"string","description":"The username of the evaluator (user who evaluated the attempt)"}}},"CourseCoursesGetLosAssignmentAttemptsExtraData":{"required":["total_file_count"],"properties":{"total_file_count":{"type":"integer","description":"Total number of files and links uploaded (per page)"}}},"CourseCoursesGetLosAssignmentAttemptsLinks":{"required":["self","next","prev","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsSelf","description":"Link to the current page"},"next":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsNext","description":"Link to the next page"},"prev":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsPrev","description":"Link to the previous page"},"goto":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesGetLosAssignmentAttemptsLast","description":"Link to the last page"}}},"CourseCoursesGetLosAssignmentAttemptsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesGetLosAssignmentAttemptsNext":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the next page"}}},"CourseCoursesGetLosAssignmentAttemptsPrev":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the previous page"}}},"CourseCoursesGetLosAssignmentAttemptsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesGetLosAssignmentAttemptsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesGetLosAssignmentAttemptsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesUpdateTrainingMaterialSettingsSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"","items":{"$ref":"#/definitions/CourseCoursesUpdateTrainingMaterialSettingsItems"}}}},"CourseCoursesUpdateTrainingMaterialSettingsItems":{"required":["tm_id"],"properties":{"tm_id":{"type":"integer","description":"training material identifier"},"visible":{"type":"boolean","description":"whether the training material should be visible by learners"},"publish_from":{"type":"string","description":"publication start date expressed as M/d/Y"},"publish_to":{"type":"string","description":"publication end date expressed as M/d/Y"},"self_prerequisite":{"type":"enum(*,incomplete,NULL)","description":"Number of views"},"is_terminator":{"type":"boolean","description":"If true completing the tm you complete the course too"},"width":{"type":"string","description":"training material&#039;s width in pixel or percentage"},"height":{"type":"string","description":"training material&#039;s height in pixel or percentage"},"launch_mode":{"description":"","enum":["inline","lightbox","new_window"],"type":"string"},"folder_id":{"type":"integer","description":"when given, the training material will be moved to this folder"},"milestone":{"description":"training material milestone type","enum":["-","start","end"],"type":"string"}}},"CourseCoursesUpdateTrainingMaterialSettingsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesUpdateTrainingMaterialSettingsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseCoursesUpdateTrainingMaterialSettingsData":{},"CourseCoursesTestAttemptsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesTestAttemptsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesTestAttemptsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesTestAttemptsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count","sort"],"properties":{"items":{"type":"array","description":"Array of attempts","items":{"$ref":"#/definitions/CourseCoursesTestAttemptsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of Pages"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/CourseCoursesTestAttemptsSort"}}}},"CourseCoursesTestAttemptsItems":{"required":["username","first_name","last_name","submission_date","score","max_score","status","questions"],"properties":{"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"submission_date":{"type":"string","format":"date","description":"Date and time indicating when the attempt has been submitted"},"score":{"type":"number","format":"float","description":"The score obtained in the test attempt"},"max_score":{"type":"integer","description":"The maximum obtainable score for the test"},"status":{"description":"The status of the attempt.","enum":["passed","not_passed","valid","not_checked","not_complete","doing"],"type":"string"},"questions":{"type":"array","description":"","items":{"$ref":"#/definitions/CourseCoursesTestAttemptsQuestions"}}}},"CourseCoursesTestAttemptsQuestions":{"required":["id","title","answers"],"properties":{"id":{"type":"integer","description":""},"title":{"type":"string","description":""},"answers":{"type":"array","description":"","items":{"$ref":"#/definitions/CourseCoursesTestAttemptsAnswers"}}}},"CourseCoursesTestAttemptsAnswers":{"required":["user_input"],"properties":{"user_input":{"type":"string","description":"Readable answer text"},"is_correct":{"type":"boolean","description":"Whether the given answer is correct. Null when question was &#039;upload&#039; or &#039;extended text&#039;"}}},"CourseCoursesTestAttemptsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["idst","username","first_name","last_name"],"type":"string"},"sort_dir":{"description":"Sorting direction","enum":["asc","desc"],"type":"string"}}},"CourseCoursesTestAttemptsLinks":{"properties":{"self":{"$ref":"#/definitions/CourseCoursesTestAttemptsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseCoursesTestAttemptsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseCoursesTestAttemptsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseCoursesTestAttemptsLast","description":"Link to the last page"}}},"CourseCoursesTestAttemptsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseCoursesTestAttemptsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseCoursesTestAttemptsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseCoursesTestAttemptsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseCoursesArchiveSchema":{"type":"object","required":["items","options"],"properties":{"items":{"type":"array","description":"List of course IDs to archive","items":{"$ref":"#/definitions/CourseCoursesArchiveItems"}},"options":{"$ref":"#/definitions/CourseCoursesArchiveOptions","description":"Additional options"}}},"CourseCoursesArchiveItems":{},"CourseCoursesArchiveOptions":{"required":["upload_training_materials"],"properties":{"upload_training_materials":{"type":"boolean","description":"If true, upload training materials to CLOR during archive"}}},"CourseCoursesArchiveResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesArchiveData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesArchiveLinks","description":"Links to related resources."}}},"CourseCoursesArchiveData":{"required":["items"],"properties":{"items":{"type":"array","description":"Per-item archive validation result","items":{"$ref":"#/definitions/CourseCoursesArchiveItemsL2"}}}},"CourseCoursesArchiveItemsL2":{"required":["course_id","success"],"properties":{"course_id":{"type":"integer","description":"Course ID"},"success":{"type":"boolean","description":"True if item can be archived"},"code":{"type":"integer","description":"Error code when success=false"},"message":{"type":"string","description":"Error message when success=false"}}},"CourseCoursesArchiveLinks":{},"CourseCoursesUpdateCourseTranslationsSchema":{"type":"object","properties":{"course_information_translations":{"type":"array","description":"Array of translations for this course","items":{"$ref":"#/definitions/CourseCoursesUpdateCourseTranslationsCourseInformationTranslations"}}}},"CourseCoursesUpdateCourseTranslationsCourseInformationTranslations":{"required":["lang_code"],"properties":{"lang_code":{"type":"string","description":"The lang code of the translation"},"short_description":{"type":"string","description":"The translated short description. Max 130 chars."},"name":{"type":"string","description":"The translated course name. Max 255 chars."},"description":{"type":"string","description":"The translated description."},"source":{"description":"The translation source","enum":["as_default","manual","ai"],"type":"string"}}},"CourseCoursesUpdateCourseTranslationsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesUpdateCourseTranslationsData","description":"Results of the assign process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseCoursesUpdateCourseTranslationsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseCoursesUpdateCourseTranslationsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"The response status"}}},"CourseCoursesUpdateCourseTranslationsLinks":{},"CourseCoursesListCourseTranslationsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"","items":{"$ref":"#/definitions/CourseCoursesListCourseTranslationsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"","items":{"$ref":"#/definitions/CourseCoursesListCourseTranslationsLinks"}}}},"CourseCoursesListCourseTranslationsData":{"required":["lang_code","name","description","short_description","source"],"properties":{"lang_code":{"type":"string","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""},"short_description":{"type":"string","description":""},"source":{"type":"string","description":""}}},"CourseCoursesListCourseTranslationsLinks":{},"CourseCoursesDeleteCourseTranslationsSchema":{"type":"object","required":["lang_codes"],"properties":{"lang_codes":{"type":"array","description":"Array of language codes to remove. Empty array is allowed (no-op).","items":{"$ref":"#/definitions/CourseCoursesDeleteCourseTranslationsLangCodes"}}}},"CourseCoursesDeleteCourseTranslationsLangCodes":{},"CourseCoursesDeleteCourseTranslationsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseCoursesDeleteCourseTranslationsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/CourseCoursesDeleteCourseTranslationsLinks"}}}},"CourseCoursesDeleteCourseTranslationsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"True when the operation completed successfully"}}},"CourseCoursesDeleteCourseTranslationsLinks":{},"CourseEventsGetEventResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsGetEventData","description":"Event details API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsGetEventData":{"required":["course","session","instructors","event_id","name","day","description","time_begin","time_end","break_begin","break_end","timezone","id_classroom","id_location","effective_duration","collaboration_tool","cover_image","webinar_tool","webinar_tool_sync_failed","external_calendar_sync_failed","id_tool_account","name_tool_account","custom_url","allow_recording_completion","allow_join_completion","lastEdit","zoom_v3_registration_enabled","zoom_v3_settings_template","zoom_v3_authentication_method","zoom_v3_account_id"],"properties":{"course":{"$ref":"#/definitions/CourseEventsGetEventCourse","description":"The course related to this event"},"session":{"$ref":"#/definitions/CourseEventsGetEventSession","description":"The session related to this event"},"instructors":{"type":"array","description":"The instructors related to this event","items":{"$ref":"#/definitions/CourseEventsGetEventInstructors"}},"event_id":{"type":"integer","description":"ID of the event"},"name":{"type":"string","description":"Name of the event"},"day":{"type":"string","description":"Date of the event"},"description":{"type":"string","description":"Description of the event"},"time_begin":{"type":"string","description":"Begin time of the event"},"time_end":{"type":"string","description":"End time of the event"},"break_begin":{"type":"string","description":"Break begin time of the event"},"break_end":{"type":"string","description":"Break end time of the event"},"timezone":{"type":"string","description":"Timezone of the event"},"id_classroom":{"type":"integer","description":"ID of the classroom of the event"},"id_location":{"type":"integer","description":"ID of the location of the event"},"qr_tracking_enabled":{"type":"boolean","description":"True if attendance tracking via QR code is enabled"},"qr_geolocation_enabled":{"type":"boolean","description":"True if geolocation when tracking attendance via QR code is enabled"},"effective_duration":{"type":"string","description":"Effective duration of the event (HH:MM)"},"collaboration_tool":{"type":"string","description":"Collaboration tool of the event"},"cover_image":{"type":"string","description":"Cover image url of the event"},"webinar_tool":{"type":"string","description":"Webinar tool of the event"},"webinar_tool_sync_failed":{"type":"boolean","description":"Check if the webinar tool is synced"},"external_calendar_sync_failed":{"type":"boolean","description":"Check if the external calendar is synced (allowed values: null | true | false) is NOT returned when the toggle release/weekly/vilt-rsvp is OFF, is always returned null when the Advance Settings &gt; ILT &gt; RSVP is OFF, is always returned null when the external calendar RSVP sync is disabled for the event (at session or course level)"},"id_tool_account":{"type":"integer","description":"ID tool account of the event"},"name_tool_account":{"type":"string","description":"Name of the tool account of the event"},"password":{"type":"string","description":"Password to access the remote event"},"custom_url":{"type":"string","description":"URL of the custom tool of the event (if custom tool has been used)"},"allow_recording_completion":{"type":"boolean","description":"Completion rule by watching a recording of this event"},"allow_join_completion":{"type":"boolean","description":"Completion rule by joining this event"},"join_in_advance_time_user":{"type":"integer","description":"Number of minutes to allow the learners to join the event before it starts"},"join_in_advance_time_teacher":{"type":"integer","description":"Number of minutes to allow the teachers to join the event before it starts"},"lastEdit":{"$ref":"#/definitions/CourseEventsGetEventLastEdit","description":"Edit information about this event"},"zoom_v3_registration_enabled":{"type":"boolean","description":"Zoom v3 is registration required to participate to meeting"},"zoom_v3_settings_template":{"type":"string","description":"Zoom v3 template id"},"zoom_v3_host":{"type":"array","description":"The user data of the Zoom V3 user who hosts the meeting","items":{"$ref":"#/definitions/CourseEventsGetEventZoomV3Host"}},"zoom_v3_alternative_hosts":{"type":"array","description":"The users&#039; data of the Zoom V3 users who host the meeting","items":{"$ref":"#/definitions/CourseEventsGetEventZoomV3AlternativeHosts"}},"zoom_v3_authentication_method":{"type":"string","description":"Zoom v3 authentication method"},"zoom_v3_account_id":{"type":"string","description":"Zoom v3 account id"}}},"CourseEventsGetEventCourse":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of the course"},"name":{"type":"string","description":"Name of the course"}}},"CourseEventsGetEventSession":{"required":["id","name","created_by"],"properties":{"id":{"type":"integer","description":"ID of the session"},"name":{"type":"string","description":"Name of the session"},"created_by":{"type":"integer","description":"Who created the session"}}},"CourseEventsGetEventInstructors":{"required":["user_id","firstname","lastname","username","event_only"],"properties":{"user_id":{"type":"integer","description":"ID of the instructor"},"firstname":{"type":"string","description":"First name of the instructor"},"lastname":{"type":"string","description":"Last name of the instructor"},"username":{"type":"string","description":"Username of the instructor"},"event_only":{"type":"boolean","description":"If this instructor is managing only this event or also the session"}}},"CourseEventsGetEventLastEdit":{"required":["userId","firstName","lastName","dateTime"],"properties":{"userId":{"type":"integer","description":"ID of the user that modified this event"},"firstName":{"type":"string","description":"First name of the user that modified this event"},"lastName":{"type":"string","description":"Last name of the user that modified this event"},"dateTime":{"type":"string","description":"Last date of modification"}}},"CourseEventsGetEventZoomV3Host":{"required":["id","email"],"properties":{"id":{"type":"integer","description":"ID of the user"},"email":{"type":"string","description":"Email of the user"}}},"CourseEventsGetEventZoomV3AlternativeHosts":{"required":["id","email"],"properties":{"id":{"type":"integer","description":"ID of the user"},"email":{"type":"string","description":"Email of the user"}}},"CourseEventsEditEventSchema":{"type":"object","properties":{"instructors":{"type":"array","description":"The instructors to be assigned to this event (must be a valid id, must not exceed 200 maximum assignable instructors)","items":{"type":"integer"}},"name":{"type":"string","description":"Name of the event"},"day":{"type":"string","description":"Day of the event (YYYY-MM-DD format)"},"description":{"type":"string","description":"Description of the event"},"time_begin":{"type":"string","description":"Time begin of the event (HH:mm:ss format)"},"time_end":{"type":"string","description":"Time end of the event (HH:mm:ss format, must be after time_begin)"},"break_begin":{"type":"string","description":"Break begin of the event (HH:mm:ss format, must be after time_begin, must be used together with break_end)"},"break_end":{"type":"string","description":"Break end of the event (HH:mm:ss format, must be before time_end, must be used together with break_begin)"},"timezone":{"type":"string","description":"Timezone of the event (IANA timezone id, eg: Europe/Rome. Find the full list of accepted values in the Advanced Settings area, Date and Time tab)"},"id_classroom":{"type":"integer","description":"ID of the classroom of the event (must be a valid id, can be used when location_id is specified but must be compatible with the location)"},"id_location":{"type":"integer","description":"ID of the location of the event (must be a valid id, can be used without id_classroom)"},"qr_tracking_enabled":{"type":"boolean","description":"Enable attendance tracking via QR code"},"qr_geolocation_enabled":{"type":"boolean","description":"Enable geolocation when tracking attendance via QR code"},"collaboration_tool":{"type":"string","description":"Collaboration tool used for the event"},"cover_image":{"type":"integer","description":"Id of the cover image of the event"},"webinar_tool":{"type":"string","description":"Name of the tool used for this event (custom or third party, must be a valid value)"},"id_tool_account":{"type":"integer","description":"ID of the webinar tool account (can be used if &quot;custom&quot; webinar_tool is not passed, must be a valid id)"},"password":{"type":"string","description":"Password to access the remote event (is a mandatory field when the webinar_tool parameter is passed and it is not set to &quot;custom&quot;. If not specified, the system will automatically generate a password for the webinar)"},"custom_url":{"type":"string","description":"Url ot the custom webinar tool (is mandatory when the webinar_tool parameter is set to &quot;custom&quot;. Not compatible with other tools.)"},"allow_recording_completion":{"type":"boolean","description":"Completion by watching the recording of the event (this param must only be used in conjunction with webinar_tool)"},"allow_join_completion":{"type":"boolean","description":"Completion by joining the event (this param must only be used in conjunction with webinar_tool)"},"required_completion_percentage":{"type":"integer","description":"The required watching percentage to trigger event completion rules (can be used only when a Webinar Tool is set to Adobe Connect V2 Meeting or Webinar)"},"join_in_advance_time_user":{"type":"string","description":"Time to allow the learners to join the event before it starts (H:i format, can be used only when webinar_tool parameter is passed, cannot be earlier than join_in_advance_time_teacher)"},"join_in_advance_time_teacher":{"type":"string","description":"Time to allow the teachers to join the event before it starts (H:i format, can be used only when webinar_tool parameter is passed, cannot be later than join_in_advance_time_user)"},"adobe_connect_v2_template":{"type":"string","description":"SCO-ID of the template in the AdobeConnect V2 Account (can be passed as an empty string)"},"adobe_connect_v2_folder":{"type":"string","description":"SCO-ID of the folder in the AdobeConnect  V2 Account (can be passed as an empty string)"},"adobe_connect_v2_room":{"type":"string","description":"SCO-ID of the room in the AdobeConnect  V2 Account (can be passed as an empty string. It is mandatory when using Adobe Connect V2 Seminar as webinar_tool)"},"xapi_oauth_account":{"type":"string","description":"When xAPI tool is used - oauth account used for this app (can be passed as an empty string)"},"xapi_url":{"type":"string","description":"When xAPI tool is used - url used for this app (can be passed as an empty string)"},"zoom_v3_settings_template":{"type":"string","description":"The settings template ID on ZoomV3"},"zoom_v3_account_id":{"type":"integer","description":"Zoom V3 Account ID"},"zoom_v3_host":{"type":"string","description":"The user ID of the Zoom V3 user who hosts the meeting"},"zoom_v3_alternative_hosts":{"type":"array","description":"The user IDs of the Zoom V3 users who host the meeting","items":{"type":"integer"}},"zoom_v3_registration_enabled":{"type":"boolean","description":"if set to true, the registration will be required in the meeting"},"zoom_v3_authentication_method":{"type":"string","description":"the Zoom v3 authentication method"}},"required":["name","day","time_begin","time_end","timezone"]},"CourseEventsEditEventResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsEditEventData","description":"Event edit API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsEditEventData":{"required":["event_id"],"properties":{"event_id":{"type":"integer","description":"ID of the edited event"},"webinar_tool_sync_failed":{"type":"boolean","description":"The tool synchronization status"},"password_generated":{"type":"string","description":"The password random generated for the webinar tool"}}},"CourseEventsDeleteEventResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsDeleteEventData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsDeleteEventData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Result of the request"}}},"CourseEventsListAttendanceResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsListAttendanceData","description":"Enrolled users list API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsListAttendanceData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"Array of Users","items":{"$ref":"#/definitions/CourseEventsListAttendanceItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseEventsListAttendanceItems":{"properties":{"email":{"type":"string","description":"Email of thr user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"status_id":{"type":"integer","description":"Id of status"},"status":{"type":"string","description":"Attendance status"},"time":{"type":"integer","description":"Attendance time in minutes"},"duration":{"type":"integer","description":"Event duration in minutes"},"user_id":{"type":"string","description":"ID of the user"}},"required":["username","first_name","status_id","status","time","duration","user_id"]},"CourseEventsEditAttendanceSchema":{"type":"object","required":["user_id","status"],"properties":{"user_id":{"type":"integer","description":"ID of the user"},"status":{"type":"integer","description":"Status of attendance (0: Absent, 1: Present, -1: Not set)"},"time":{"type":"integer","description":"Time of attendance in minutes (required greater than 0 for &#039;Present&#039; and equal to or greater than 0 for &#039;Absent&#039;, not expected or 0 for &#039;Not set&#039;)"}}},"CourseEventsEditAttendanceResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsEditAttendanceData","description":"Success or failure"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsEditAttendanceData":{},"CourseEventsDuplicateEventSchema":{"type":"object","required":["name","day"],"properties":{"name":{"type":"string","description":"Name of the duplicated event"},"day":{"type":"string","description":"Date of the duplicated event"},"assign_instructors":{"type":"boolean","description":"Flag to assign the existing instructors to the duplicated event"},"id_session":{"type":"integer","description":"ID of an existing session to place the duplicated event"}}},"CourseEventsDuplicateEventResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsDuplicateEventData","description":"Duplicate event API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsDuplicateEventData":{"required":["event_id"],"properties":{"event_id":{"type":"integer","description":"ID of the duplicated event"}}},"CourseEventsSyncEventResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsSyncEventData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsSyncEventData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Result of the request"}}},"CourseEventsUploadRecordingSchema":{"type":"object","required":["recording_type"],"properties":{"recording_type":{"type":"integer","description":"Type of recording for the webinar session. Possible values: 1 - Api Grab; 2 - Upload; 3 - Weblink; 4 - Api Link;"},"url":{"type":"string","description":"External video link"},"filename":{"type":"string","description":"Name of the video file uploaded to S3 storage under the webinar recordings collection and which is to be converted to HLS playlist"}}},"CourseEventsUploadRecordingResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsUploadRecordingData","description":"Contains simple &quot;success&quot; flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsUploadRecordingData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"}}},"CourseEventsDeleteRecordingResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsDeleteRecordingData","description":"Contains simple &quot;success&quot; flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsDeleteRecordingData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"}}},"CourseEventsGetRecordingStatusResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsGetRecordingStatusData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsGetRecordingStatusData":{"required":["status"],"properties":{"status":{"type":"string","description":"The status of the recording"}}},"CourseEventsGetRecordingResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsGetRecordingData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsGetRecordingData":{"properties":{"recording":{"type":"array","description":"This object contains the info needed to play the recording","items":{"$ref":"#/definitions/CourseEventsGetRecordingRecording"}}}},"CourseEventsGetRecordingRecording":{"required":["type","url"],"properties":{"type":{"type":"string","description":"Type of the recording. Possible types = &quot;video&quot;, &quot;iframe&quot;."},"url":{"type":"string","description":"If the type of recording is &quot;iframe&quot; this contains the URL for that recording&#039;s opening. If it&#039;s &quot;video&quot; then this contains the MP4 URL to play."},"hls":{"type":"string","description":"If the type of the recording is &quot;video&quot; this can contain an URL to a HLS playlist."}}},"CourseEventsGetJoinUrlResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsGetJoinUrlData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsGetJoinUrlData":{"required":["join_url"],"properties":{"join_url":{"type":"string","description":"If the user is joining or starting the webinar session and not watching the video recording, this parameter indicates the link to be used to redirect the user to the actual webinar"}}},"CourseEventsImporterFieldsEventResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsImporterFieldsEventData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseEventsImporterFieldsEventData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/CourseEventsImporterFieldsEventFields"}}}},"CourseEventsImporterFieldsEventFields":{},"CourseEventsListRsvpEventResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseEventsListRsvpEventData","description":"Session listing API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/CourseEventsListRsvpEventLinks"}}}},"CourseEventsListRsvpEventData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"Array of Events","items":{"$ref":"#/definitions/CourseEventsListRsvpEventItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseEventsListRsvpEventItems":{"required":["user_id","username","email","first_name","last_name","enrollment_date","enrollment_status","enrollment_status_id","user_status","user_status_id","rsvp"],"properties":{"user_id":{"type":"integer","description":"ID of the user"},"username":{"type":"string","description":"Username of the user"},"email":{"type":"string","description":"Email of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"enrollment_date":{"type":"string","format":"date","description":"Enrollment date and time for the session &quot;2021-06-10 06:44:09&quot; UTC"},"enrollment_status":{"type":"string","description":"Enrollment status &quot;(Waiting Users, Enrolled, In Progress, Completed, Suspended)&quot;"},"enrollment_status_id":{"type":"integer","description":"ID of the enrollment status &quot;(-2, 0, 1, 2, 3)&quot;"},"user_status":{"type":"string","description":"User status &quot;(Active, Deactivated)&quot;"},"user_status_id":{"type":"integer","description":"ID of the user status &quot;(1,0)&quot;"},"rsvp":{"type":"integer","description":"Response from user &quot;0=awaiting, 1=no, 2=maybe, 3=yes&quot;"}}},"CourseEventsListRsvpEventLinks":{},"CourseInstructorsFreeBusySchema":{"type":"object","properties":{"id_session":{"type":"integer","description":"Availability session"},"day":{"type":"string","description":"Availability day (YYYY-MM-DD format)"},"time_begin":{"type":"string","description":"Availability time begin (HH:mm:ss format)"},"time_end":{"type":"string","description":"Availability time end (HH:mm:ss format)"},"break_begin":{"type":"string","description":"Availability break begin (HH:mm:ss format)"},"break_end":{"type":"string","description":"Availability break end (HH:mm:ss format)"},"timezone":{"type":"string","description":"Availability timezone (Europe/Rome format)"},"ignore_event":{"type":"string","description":"An event ID to exclude from the availability"}}},"CourseInstructorsFreeBusyResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseInstructorsFreeBusyData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseInstructorsFreeBusyData":{"required":["status"],"properties":{"status":{"description":"Instructor availability status","enum":["busy","free"],"type":"string"}}},"CourseInstructorsBatchAssignSchema":{"type":"object","required":["items","options"],"properties":{"items":{"type":"array","description":"Array containing sessions or events to which to add instructors","items":{"$ref":"#/definitions/CourseInstructorsBatchAssignItems"}},"options":{"$ref":"#/definitions/CourseInstructorsBatchAssignOptions","description":"Object containing the list of instructors to add to a session or event and the type of assignment"}}},"CourseInstructorsBatchAssignItems":{"required":["id"],"properties":{"id":{"type":"integer","description":"Session or Event ID (must be all valid ids, must contain only session or only event ids matching the type parameter)"}}},"CourseInstructorsBatchAssignOptions":{"required":["instructors","type"],"properties":{"instructors":{"type":"array","description":"Array of Instructors ID (must be all valid ids, must not be already assigned, must not exceed 200 maximum assignable instructors)","items":{"type":"integer"}},"type":{"type":"string","description":"Type of item (can be either &quot;session&quot; or &quot;event&quot;, must be set to match the same entity represented by the ids passed into items)"},"replace":{"type":"boolean","description":"Choose whether to replace instructors currently assigned to the session or event. Default false."}}},"CourseInstructorsBatchAssignResponse":{"required":["data","version","version"],"properties":{"data":{"type":"array","description":"The list of items with the operations&#039; outcome for each one.","items":{"$ref":"#/definitions/CourseInstructorsBatchAssignData"}},"version":{"type":"string","required":"required","description":"Current API version"},"massive_actions_summary":{"$ref":"#/definitions/CourseInstructorsBatchAssignMassiveActionsSummary","description":"Massive actions bar summary, present only if one or more items have success equal to false"}}},"CourseInstructorsBatchAssignData":{"required":["id","success"],"properties":{"id":{"type":"integer","description":"The session&#039;s ID"},"success":{"type":"boolean","description":"true if the request has been successful"}}},"CourseInstructorsBatchAssignMassiveActionsSummary":{"required":["total_items","failed_items","successful_items","message"],"properties":{"total_items":{"type":"integer","description":"Total number of items involved by the operation"},"failed_items":{"type":"integer","description":"Total number of failed items"},"successful_items":{"type":"integer","description":"Total number of successful items"},"message":{"type":"string","description":"informative error message"}}},"CourseInstructorsImporterFieldsInstructorResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseInstructorsImporterFieldsInstructorData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseInstructorsImporterFieldsInstructorData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/CourseInstructorsImporterFieldsInstructorFields"}}}},"CourseInstructorsImporterFieldsInstructorFields":{},"CourseInstructorsInstructorsResponse":{"required":["data","version","extra_data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseInstructorsInstructorsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/CourseInstructorsInstructorsExtraData","description":"Extra information"},"_links":{"$ref":"#/definitions/CourseInstructorsInstructorsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseInstructorsInstructorsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"","items":{"$ref":"#/definitions/CourseInstructorsInstructorsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/CourseInstructorsInstructorsSort"}}}},"CourseInstructorsInstructorsItems":{"required":["user_id","firstname","lastname","username","email","sessions"],"properties":{"user_id":{"type":"integer","description":""},"firstname":{"type":"string","description":""},"lastname":{"type":"string","description":""},"username":{"type":"string","description":""},"email":{"type":"string","description":""},"sessions":{"type":"array","description":"","items":{"$ref":"#/definitions/CourseInstructorsInstructorsSessions"}},"events":{"type":"array","description":"","items":{"$ref":"#/definitions/CourseInstructorsInstructorsEvents"}}}},"CourseInstructorsInstructorsSessions":{"required":["course_id","session_id"],"properties":{"course_id":{"type":"integer","description":""},"session_id":{"type":"integer","description":""}}},"CourseInstructorsInstructorsEvents":{"required":["course_id","session_id","event_id"],"properties":{"course_id":{"type":"integer","description":""},"session_id":{"type":"integer","description":""},"event_id":{"type":"integer","description":""}}},"CourseInstructorsInstructorsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["user_id"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"CourseInstructorsInstructorsExtraData":{"required":["total_count","total_with_email_count","session_instructors_count"],"properties":{"total_count":{"type":"integer","description":"total instructors counter"},"total_with_email_count":{"type":"integer","description":"total instructors with email counter"},"session_instructors_count":{"type":"integer","description":"total instructors assigned to sessions counter"}}},"CourseInstructorsInstructorsLinks":{"required":["self","next","prev","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseInstructorsInstructorsSelf","description":"Link to the current page"},"next":{"$ref":"#/definitions/CourseInstructorsInstructorsNext","description":"Link to the next page"},"prev":{"$ref":"#/definitions/CourseInstructorsInstructorsPrev","description":"Link to the previous page"},"goto":{"$ref":"#/definitions/CourseInstructorsInstructorsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseInstructorsInstructorsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseInstructorsInstructorsLast","description":"Link to the last page"}}},"CourseInstructorsInstructorsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseInstructorsInstructorsNext":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the next page"}}},"CourseInstructorsInstructorsPrev":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the previous page"}}},"CourseInstructorsInstructorsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseInstructorsInstructorsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseInstructorsInstructorsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseInstructorsSendEmailToInstructorsSchema":{"type":"object","required":["type","type_ids","subject","message"],"properties":{"type":{"description":"which entity the type_ids represent","enum":["course","session","event"],"type":"string"},"type_ids":{"type":"array","description":"list of ids representing the entities which instructors will be emailed","items":{"type":"integer"}},"instructor_ids":{"type":"array","description":"The ids of the instructors to email","items":{"type":"integer"}},"subject":{"type":"string","description":"Email&#039;s subject"},"message":{"type":"string","description":"Email&#039;s body"},"sender":{"type":"string","description":"Email of the sender"},"events_only":{"type":"boolean","description":"Whether to exclude session instructors"},"filter_events_end_after_date_utc":{"type":"string","format":"date","description":"Filter events by end date in case of massive action"}}},"CourseInstructorsSendEmailToInstructorsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseInstructorsSendEmailToInstructorsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseInstructorsSendEmailToInstructorsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":""}}},"CourseInstructorsBatchRemoveInstructorsSchema":{"type":"object","required":["items","options"],"properties":{"items":{"type":"array","description":"Array containing session or event id for which instructors will be deleted","items":{"$ref":"#/definitions/CourseInstructorsBatchRemoveInstructorsItems"}},"options":{"$ref":"#/definitions/CourseInstructorsBatchRemoveInstructorsOptions","description":"Object containing an array of instructors id and the type of items id (session or event)"}}},"CourseInstructorsBatchRemoveInstructorsItems":{"required":["id"],"properties":{"id":{"type":"integer","description":"Session or Event ID"}}},"CourseInstructorsBatchRemoveInstructorsOptions":{"required":["instructors","type"],"properties":{"instructors":{"type":"array","description":"Array of instructors id","items":{"type":"integer"}},"type":{"type":"string","description":"Type of items id (session or event)"}}},"CourseInstructorsBatchRemoveInstructorsResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"The API result","items":{"$ref":"#/definitions/CourseInstructorsBatchRemoveInstructorsData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseInstructorsBatchRemoveInstructorsData":{"required":["id","num_deleted"],"properties":{"id":{"type":"integer","description":"the id of the session or event"},"num_deleted":{"type":"integer","description":"number of instructors removed from the session or event"}}},"CourseSessionsEditSessionSchema":{"type":"object","properties":{"instructors":{"type":"array","description":"Internal ID of the Instructors (must be a valid id, must not exceed 200 maximum assignable instructors, if not passed it will be reset)","items":{"type":"integer"}},"additional_fields":{"type":"array","description":"Additional fields value. For &quot;date&quot; type the date format should be &quot;yyyy-mm-dd&quot; (if not passed, it will be reset). This field becomes mandatory if there is at least one mandatory additional field, and it must contain all mandatory additional fields.","items":{"$ref":"#/definitions/CourseSessionsEditSessionAdditionalFields"}},"name":{"type":"string","description":"Name of the session"},"code":{"type":"string","description":"Code to identify the session (if not passed it will be reset)"},"description":{"type":"string","description":"Description of the session (if not passed it will be reset)"},"min_enroll":{"type":"integer","description":"Minimum number of enrollable users (must be greater than or equal to zero, if not passed it will be reset)"},"max_enroll":{"type":"integer","description":"Maximum number of enrollable users (must be greater than zero and min_enroll)"},"score_base":{"type":"integer","description":"Evaluation score base (greater than zero, if evaluation_type = 0, if not passed, it will be reset)"},"enrollment_deadline":{"type":"string","description":"The deadline for the learner to self enroll in the session. The date format should be &quot;yyyy-mm-dd&quot; (must be passed without custom_deadline_days, if not passed it will be reset)"},"custom_deadline_days":{"type":"integer","description":"The number of days before the session start date the learner can self enroll into the session (must be passed without enrollment_deadline, if not passed it will be reset)"},"evaluation_type":{"type":"integer","description":"Evaluation type (0: based on score, 1: based on test, 2: based on attendance dates, 3: manual)"},"min_attended_dates_for_completion":{"type":"integer","description":"The minimum number of events users have to attend in a session to mark it as completed (must greater than zero, can only be used with evaluation_type = 2, if not passed it will be reset)"},"custom_rsvp_enabled":{"type":"boolean","description":"Enable or disable the custom option for the RSVP into the session. When set, this overrides the course RSVP setting. Allowed values: null, false, true. The default value is “null” (if not passed it will be reset). This parameter is ignored when the RSVP feature is not enabled on the platform."},"enable_deeplink":{"type":"boolean","description":"Enable or disable the enrollment deeplink for the session. Allowed values: false, true, null. If omitted or null will be ignored"}},"required":["name","max_enroll","evaluation_type"]},"CourseSessionsEditSessionAdditionalFields":{"properties":{"id":{"type":"integer","description":"Internal ID of the field"},"value":{"type":"string","description":"Value of the field"}}},"CourseSessionsEditSessionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsEditSessionData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsEditSessionData":{"required":["id_session"],"properties":{"id_session":{"type":"integer","description":"Result of the request"}}},"CourseSessionsDeleteSessionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsDeleteSessionData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsDeleteSessionData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Result of the request"},"errors":{"type":"boolean","description":"Flag to inform the caller if errors arisen during the deletion"}}},"CourseSessionsListEventsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsListEventsData","description":"Session listing API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsListEventsData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"Array of Events","items":{"$ref":"#/definitions/CourseSessionsListEventsItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseSessionsListEventsItems":{"required":["id","type","name","date","time","break","duration","schedule","location","classroom","webinar_tool","webinar_tool_sync_failed","external_calendar_sync_failed","external_calendar_rsvp","instructors","instructors_emails_number","attendance","enrolled"],"properties":{"id":{"type":"integer","description":"ID of the event"},"type":{"description":"Type of the event (onsite = configured with only a venue, online = configured with only a tool, flexible = both)","enum":["onsite","online","flexible"],"type":"string"},"name":{"type":"string","description":"Name of the event"},"date":{"type":"string","description":"Start date of the event"},"time":{"type":"string","description":"Duration in hours of the event"},"break":{"type":"string","description":"Duration in hours of the break event"},"duration":{"type":"integer","description":"Duration in hours of the event"},"schedule":{"$ref":"#/definitions/CourseSessionsListEventsSchedule","description":"Schedule of the event"},"location":{"$ref":"#/definitions/CourseSessionsListEventsLocation","description":"Location of the event (can be NULL if no location is assigned)"},"classroom":{"$ref":"#/definitions/CourseSessionsListEventsClassroom","description":"Classroom of the event (can be NULL if no classroom is assigned)"},"qr_tracking_enabled":{"type":"boolean","description":"True if attendance tracking via QR code is enabled"},"qr_geolocation_enabled":{"type":"boolean","description":"True if geolocation when tracking attendance via QR code is enabled"},"webinar_tool_name":{"type":"string","description":"Name of the webinar_tool"},"webinar_tool":{"type":"boolean","description":"Check if the event has a webinar tool"},"webinar_tool_sync_failed":{"type":"boolean","description":"Check if the webinar tool is synced"},"external_calendar_sync_failed":{"type":"boolean","description":"Check if the external calendar is synced (is NOT returned when the toggle release/weekly/vilt-rsvp is OFF, is always returned null when the Advance Settings &gt; ILT &gt; RSVP is OFF, is always returned null when the external calendar RSVP sync is disabled for the event (at session or course level))"},"external_calendar_rsvp":{"$ref":"#/definitions/CourseSessionsListEventsExternalCalendarRsvp","description":"Object containing the count of RSVP feedbacks by type (is NOT returned when the toggle release/weekly/vilt-rsvp is OFF, is always returned null when the Advance Settings &gt; ILT &gt; RSVP is OFF, is always returned null when the external calendar RSVP sync is disabled for the event (at session or course level))"},"instructors":{"type":"integer","description":"Number of instructors"},"instructors_emails_number":{"type":"integer","description":"Number of instructors with email"},"attendance":{"type":"integer","description":"Number of attendance"},"enrolled":{"type":"integer","description":"Number of users enrolled"}}},"CourseSessionsListEventsSchedule":{"required":["date","time_begin","time_end","timezone","offset","duration"],"properties":{"date":{"type":"string","description":"Start date of the event"},"time_begin":{"type":"string","description":"Begin time of the event"},"time_end":{"type":"string","description":"End time of the event"},"break_begin":{"type":"string","description":"Break begin time of the event"},"break_end":{"type":"string","description":"Break end time of the event"},"timezone":{"type":"string","description":"Timezone of the event"},"offset":{"type":"string","description":"Timezone offset (GMT+-)"},"duration":{"type":"integer","description":"Duration in minutes of the event"}}},"CourseSessionsListEventsLocation":{"properties":{"id":{"type":"string","description":"ID of the location"},"name":{"type":"string","description":"Name of the location"},"address":{"type":"string","description":"Address of the location"}}},"CourseSessionsListEventsClassroom":{"properties":{"id":{"type":"string","description":"ID of the classroom"},"name":{"type":"string","description":"Name of the classroom"}}},"CourseSessionsListEventsExternalCalendarRsvp":{"required":["awaiting","no","maybe","yes"],"properties":{"awaiting":{"type":"integer","description":""},"no":{"type":"integer","description":""},"maybe":{"type":"integer","description":""},"yes":{"type":"integer","description":""}}},"CourseSessionsCreateEventSchema":{"type":"object","properties":{"instructors":{"type":"array","description":"The instructors to be assigned to this event (must be a valid id, must not exceed 200 maximum assignable instructors)","items":{"type":"integer"}},"name":{"type":"string","description":"Name of the event"},"day":{"type":"string","description":"Day of the event (YYYY-MM-DD format)"},"description":{"type":"string","description":"Description of the event"},"time_begin":{"type":"string","description":"Time begin of the event (HH:mm:ss format)"},"time_end":{"type":"string","description":"Time end of the event (HH:mm:ss format, must be after time_begin)"},"break_begin":{"type":"string","description":"Break begin of the event (HH:mm:ss format, must be after time_begin, must be used together with break_end)"},"break_end":{"type":"string","description":"Break end of the event (HH:mm:ss format, must be before time_end, must be used together with break_begin)"},"timezone":{"type":"string","description":"Timezone of the event (IANA timezone id, eg: Europe/Rome. Find the full list of accepted values in the Advanced Settings area, Date and Time tab)"},"id_classroom":{"type":"integer","description":"ID of the classroom of the event (must be a valid id, can be used when location_id is specified but must be compatible with the location)"},"id_location":{"type":"integer","description":"ID of the location of the event (must be a valid id, can be used without id_classroom)"},"qr_tracking_enabled":{"type":"boolean","description":"Enable attendance tracking via QR code"},"qr_geolocation_enabled":{"type":"boolean","description":"Enable geolocation when tracking attendance via QR code"},"collaboration_tool":{"type":"string","description":"Collaboration tool used for the event"},"webinar_tool":{"type":"string","description":"Name of the tool used for this event (custom or third party, must be a valid value)"},"id_tool_account":{"type":"integer","description":"ID of the webinar tool account (can be used if &quot;custom&quot; webinar_tool is not passed, must be a valid id)"},"password":{"type":"string","description":"Password to access the remote event (is a mandatory field when the webinar_tool parameter is passed and it is not set to &quot;custom&quot;. If not specified, the system will automatically generate a password for the webinar)"},"custom_url":{"type":"string","description":"Url ot the custom webinar tool (is mandatory when the webinar_tool parameter is set to &quot;custom&quot;. Not compatible with other tools.)"},"allow_recording_completion":{"type":"boolean","description":"Completion by watching the recording of the event (this param must only be used in conjunction with webinar_tool)"},"allow_join_completion":{"type":"boolean","description":"Completion by joining the event (this param must only be used in conjunction with webinar_tool)"},"required_completion_percentage":{"type":"integer","description":"The required watching percentage to trigger event completion rules (can be used only when a Webinar Tool is set to Adobe Connect V2 Meeting or Webinar)"},"join_in_advance_time_user":{"type":"string","description":"Time to allow the learners to join the event before it starts (H:i format, can be used only when webinar_tool parameter is passed, cannot be earlier than join_in_advance_time_teacher)"},"join_in_advance_time_teacher":{"type":"string","description":"Time to allow the teachers to join the event before it starts (H:i format, can be used only when webinar_tool parameter is passed, cannot be later than join_in_advance_time_user)"},"adobe_connect_v2_template":{"type":"string","description":"SCO-ID of the template in the AdobeConnect V2 Account (can be passed as an empty string)"},"adobe_connect_v2_folder":{"type":"string","description":"SCO-ID of the folder in the AdobeConnect  V2 Account (can be passed as an empty string)"},"adobe_connect_v2_room":{"type":"string","description":"SCO-ID of the room in the AdobeConnect  V2 Account (can be passed as an empty string. It is mandatory when using Adobe Connect V2 Seminar as webinar_tool)"},"xapi_oauth_account":{"type":"string","description":"When xAPI tool is used - oauth account used for this app (can be passed as an empty string)"},"xapi_url":{"type":"string","description":"When xAPI tool is used - url used for this app (can be passed as an empty string)"},"zoom_v3_host":{"type":"string","description":"The user ID of the Zoom V3 user who hosts the meeting"},"zoom_v3_alternative_hosts":{"type":"array","description":"The user IDs of the Zoom V3 users who host the meeting","items":{"type":"integer"}},"zoom_v3_settings_template":{"type":"string","description":"The settings template ID on ZoomV3"},"zoom_v3_account_id":{"type":"integer","description":"Zoom V3 Account ID"},"zoom_v3_registration_enabled":{"type":"boolean","description":"if set to true, the registration will be required in the meeting"}},"required":["name","day","time_begin","time_end","timezone"]},"CourseSessionsCreateEventResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsCreateEventData","description":"Event edit API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsCreateEventData":{"required":["event_id"],"properties":{"event_id":{"type":"integer","description":"ID of the edited event"},"webinar_tool_sync_failed":{"type":"boolean","description":"The tool synchronization status"}}},"CourseSessionsGetSessionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsGetSessionData","description":"Session details API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsGetSessionData":{"required":["course","instructors","additional_fields","session_id","name","code","description","min_enroll","max_enroll","date_start","date_end","score_base","enrollment_deadline","custom_deadline_days","evaluation_type","min_attended_dates_for_completion","has_esignature_enabled","created_by","custom_rsvp_enabled","lastEdit","deeplink"],"properties":{"course":{"$ref":"#/definitions/CourseSessionsGetSessionCourse","description":"The course related to this session"},"instructors":{"type":"array","description":"The instructors related to this session","items":{"$ref":"#/definitions/CourseSessionsGetSessionInstructors"}},"additional_fields":{"type":"array","description":"The additional fields related to this session","items":{"$ref":"#/definitions/CourseSessionsGetSessionAdditionalFields"}},"session_id":{"type":"integer","description":"ID of the session"},"migrated_webinar_session_id":{"type":"integer","description":"ID of the webinar session mapped to this ilt session (will be returned if migrated from a webinar course)"},"name":{"type":"string","description":"Name of the session"},"code":{"type":"string","description":"Code of the session"},"description":{"type":"string","description":"Description of the session"},"min_enroll":{"type":"integer","description":"Min number of enrollments for the session"},"max_enroll":{"type":"integer","description":"Max number of enrollments for the session"},"date_start":{"type":"string","description":"Start date of the session"},"date_end":{"type":"string","description":"End date of the session"},"score_base":{"type":"integer","description":"Base score for the session"},"enrollment_deadline":{"type":"string","description":"Enrollment deadline date for the session"},"custom_deadline_days":{"type":"integer","description":"Custom deadline in days for the session"},"evaluation_type":{"type":"string","description":"Session evaluation/completion type"},"min_attended_dates_for_completion":{"type":"integer","description":"Minimum attendance required to pass this session"},"has_esignature_enabled":{"type":"boolean","description":"Whether E-Signature is enabled for this course"},"created_by":{"type":"integer","description":"Who created the session"},"custom_rsvp_enabled":{"type":"boolean","description":"RSVP flag value at session level. When set, this overrides the course one. This attributes is not returned when the RSVP toggle is off. When the Advance Settings &gt; ILT &gt; RSVP is OFF this field always return NULL. Allowed values: null|false|true. Default value is null"},"lastEdit":{"$ref":"#/definitions/CourseSessionsGetSessionLastEdit","description":"Edit information about this event"},"deeplink":{"$ref":"#/definitions/CourseSessionsGetSessionDeeplink","description":"Deeplink related data"}}},"CourseSessionsGetSessionCourse":{"required":["id","name","code","rsvp_enabled"],"properties":{"id":{"type":"integer","description":"ID of the course"},"name":{"type":"string","description":"Name of the course"},"code":{"type":"string","description":"Code of the course"},"rsvp_enabled":{"type":"boolean","description":"RSVP flag value at course level. This attributes is not returned when the RSVP toggle is OFF. When the Advance Settings &gt; ILT &gt; RSVP is OFF this field always return false. Allowed values: false|true."}}},"CourseSessionsGetSessionInstructors":{"required":["user_id","firstname","lastname","username","event_only"],"properties":{"user_id":{"type":"integer","description":"ID of the instructor"},"firstname":{"type":"string","description":"First name of the instructor"},"lastname":{"type":"string","description":"Last name of the instructor"},"username":{"type":"string","description":"Username of the instructor"},"event_only":{"type":"boolean","description":"If this instructor is managing only an event of this session or also the session"}}},"CourseSessionsGetSessionAdditionalFields":{"required":["id","title","type","visible_to_user","settings","value","mandatory"],"properties":{"id":{"type":"integer","description":"ID of the additional field"},"title":{"type":"string","description":"Title of the additional field"},"type":{"type":"string","description":"Type of the additional field"},"visible_to_user":{"type":"boolean","description":"If this additional field is visible to the user"},"settings":{"type":"string","description":"Settings of the additional field"},"value":{"type":"string","description":"Value of the additional field"},"label":{"type":"string","description":"Label of the dropdown additional field"},"mandatory":{"type":"boolean","description":"If this additional field is mandatory to the user"}}},"CourseSessionsGetSessionLastEdit":{"required":["userId","firstName","lastName","dateTime"],"properties":{"userId":{"type":"integer","description":"ID of the user that modified this event"},"firstName":{"type":"string","description":"First name of the user that modified this event"},"lastName":{"type":"string","description":"Last name of the user that modified this event"},"dateTime":{"type":"string","description":"Last date of modification"}}},"CourseSessionsGetSessionDeeplink":{"required":["enabled","hash"],"properties":{"enabled":{"type":"boolean","description":"Whether the deeplink has been enabled for the session"},"hash":{"type":"string","description":"Hash used for deeplink generation"}}},"CourseSessionsListSessionEnrollmentsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsListSessionEnrollmentsData","description":"Enrolled users list API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsListSessionEnrollmentsData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of Users","items":{"$ref":"#/definitions/CourseSessionsListSessionEnrollmentsItems"}}}},"CourseSessionsListSessionEnrollmentsItems":{"properties":{"email":{"type":"string","description":"Email of thr user"},"username":{"type":"string","description":"Username of the user"},"first_name":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"completion_date":{"type":"string","description":"Completion date of the session"},"enrollment_date":{"type":"string","description":"Enrollment date for the session"},"evaluation_status":{"type":"string","description":"Evaluation status"},"evaluation":{"type":"string","description":"Evaluation score"},"evaluation_date":{"type":"string","description":"Evaluation date"},"message":{"type":"string","description":"Evaluation message"},"attachment":{"type":"string","description":"Evaluation attachment"},"status":{"type":"string","description":"Enrollment status"},"status_id":{"type":"string","description":"ID of the enrollment status"},"user_id":{"type":"string","description":"ID of the user"},"user_status":{"type":"string","description":"User status"},"user_status_id":{"type":"string","description":"ID of the user status"},"enrollment_fields":{"type":"array","description":"Additional fields of the session","items":{"$ref":"#/definitions/CourseSessionsListSessionEnrollmentsEnrollmentFields"}},"external_calendar_rsvp":{"$ref":"#/definitions/CourseSessionsListSessionEnrollmentsExternalCalendarRsvp","description":"Object containing the count of RSVP feedbacks by type (is NOT returned when the toggle release/weekly/vilt-rsvp is OFF, is always returned null when the Advance Settings &gt; ILT &gt; RSVP is OFF, is always returned null when the external calendar RSVP sync is disabled for the event (at session or course level))"},"branches":{"type":"array","description":"Array of Branches, only present if requested by passing &#039;branches&#039; to the extra_fields parameter","items":{"$ref":"#/definitions/CourseSessionsListSessionEnrollmentsBranches"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}},"required":["username","first_name","enrollment_date","status","status_id","user_id","user_status","user_status_id","external_calendar_rsvp","count","has_more_data","current_page","current_page_size","total_page_count","total_count"]},"CourseSessionsListSessionEnrollmentsEnrollmentFields":{"properties":{"id":{"type":"integer","description":"Id of the additional field"},"name":{"type":"string","description":"Name of the additional field"},"value":{"type":"string","description":"Value of the additional field"},"option_id":{"type":"integer","description":"Id of the option for the dropdown field"}}},"CourseSessionsListSessionEnrollmentsExternalCalendarRsvp":{"required":["awaiting","no","maybe","yes"],"properties":{"awaiting":{"type":"integer","description":""},"no":{"type":"integer","description":""},"maybe":{"type":"integer","description":""},"yes":{"type":"integer","description":""}}},"CourseSessionsListSessionEnrollmentsBranches":{"properties":{"id":{"type":"integer","description":"ID of the Branch"},"name":{"type":"string","description":"Name of the Branch"},"path":{"type":"array","description":"Array with Names of parents Branches","items":{"$ref":"#/definitions/CourseSessionsListSessionEnrollmentsPath"}}}},"CourseSessionsListSessionEnrollmentsPath":{},"CourseSessionsEvaluateSessionSchema":{"type":"object","required":["user_id","status"],"properties":{"user_id":{"type":"integer","description":"The internal ID of the user"},"status":{"type":"integer","description":"The status of evaluation (1: passed, -1: not passed, 0: reset the entire evaluation)"},"score":{"type":"integer","description":"The score of evaluation (required with status 1, -1)"},"completion_date":{"type":"string","description":"&quot;yyyy-mm-dd HH:mm:ss&quot; Completion date (required with status 1)"},"attachment":{"type":"string","description":"The evaluation file attachment"},"mark_as_present":{"type":"integer","description":"1: set attendance Present on all the events of the session"},"message":{"type":"string","description":"The evaluation message"}}},"CourseSessionsEvaluateSessionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsEvaluateSessionData","description":"Success or failure"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsEvaluateSessionData":{},"CourseSessionsDuplicateSessionSchema":{"type":"object","required":["name","num_duplicates"],"properties":{"name":{"type":"string","description":"Name of the duplicated session"},"num_duplicates":{"type":"integer","description":"Number of the duplicates (minimum 1)"},"frequency":{"type":"integer","description":"Frequency of the duplicated session"},"repetition":{"type":"string","description":"Repetition of the duplicated session (allowed values: daily, weekly, monthly, yearly)"},"assign_instructors":{"type":"boolean","description":"Flag to assign the existing instructors for every duplicated event"},"copy_additional_fields":{"type":"boolean","description":"Flag to indicate whether to copy additional fields (default: true). If false, remove all non-mandatory additional fields not passed in the additional_field param. Mandatory fields are never removed."},"additional_fields":{"type":"array","description":"Additional fields value. For &quot;date&quot; type the date format should be &quot;yyyy-mm-dd&quot; (if not passed, it will be reset). This field becomes mandatory if there is at least one mandatory additional field","items":{"$ref":"#/definitions/CourseSessionsDuplicateSessionAdditionalFields"}}}},"CourseSessionsDuplicateSessionAdditionalFields":{"properties":{"id":{"type":"integer","description":"Internal ID of the field"},"value":{"type":"string","description":"Value of the field"}}},"CourseSessionsDuplicateSessionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsDuplicateSessionData","description":"Duplicate session API response"},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsDuplicateSessionData":{"required":["session_ids"],"properties":{"session_ids":{"type":"array","description":"IDs of the duplicated sessions","items":{"type":"integer"}},"job_uuids":{"type":"array","description":"UUIDs of the job for event duplication","items":{"type":"string"}}}},"CourseSessionsImporterFieldsSessionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsImporterFieldsSessionData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsImporterFieldsSessionData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/CourseSessionsImporterFieldsSessionFields"}}}},"CourseSessionsImporterFieldsSessionFields":{},"CourseSessionsBatchImportSessionsSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects with data to be imported","items":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsItems"}}}},"CourseSessionsBatchImportSessionsItems":{"properties":{"course_id":{"type":"integer","description":"Internal ID of the course (cannot be passed together with course_uuid, required if course_uuid is not passed)"},"course_uuid":{"type":"string","description":"UUID of the course (cannot be passed together with course_id, required if course_id is not passed)"},"instructors_username":{"type":"array","description":"User names of the Instructors (must be a valid username, must not exceed 200 maximum assignable instructors)","items":{"type":"string"}},"instructors_id":{"type":"array","description":"Internal ID of the Instructors (must be a valid id, must not exceed 200 maximum assignable instructors)","items":{"type":"integer"}},"session_id":{"type":"integer","description":"Internal ID of the session (cannot be passed together with session_uuid,required if session_uuid is not passed, used to update an existing session)"},"session_uuid":{"type":"integer","description":"UUID of the session (cannot be passed together with session_id,required if session_id is not passed, used to update an existing session)"},"name":{"type":"string","description":"Name of the session"},"code":{"type":"string","description":"Code to identify the session"},"description":{"type":"string","description":"Description of the session"},"min_enroll":{"type":"integer","description":"Minimum number of enrollable users (must be greater than or equal to zero)"},"max_enroll":{"type":"integer","description":"Maximum number of enrollable users (must be greater than zero and min_enroll)"},"score_base":{"type":"integer","description":"Evaluation score base (must be greater than zero, is optional for every other evaluation_type but is mandatory and can only be used with evaluation_type = 0)"},"enrollment_deadline":{"type":"string","description":"The deadline for the learner to self enroll in the session. The date format should be &quot;yyyy-mm-dd&quot; (must be passed without custom_deadline_days)"},"custom_deadline_days":{"type":"integer","description":"The number of days before the session start date the learner can self enroll into the session (must be passed without enrollment_deadline)"},"evaluation_type":{"type":"integer","description":"Evaluation type (0: based on score, 1: based on test, 2: based on attendance dates, 3: manual)"},"min_attended_dates_for_completion":{"type":"integer","description":"The minimum number of events users have to attend in a session to mark it as completed (must greater than zero, can only be used with evaluation_type = 2)"},"field_1":{"type":"string","description":"First mandatory additional field to be provided (if present becomes required)"},"custom_rsvp_enabled":{"type":"boolean","description":"Check for enable/disable custom option for the rsvp into session. When set, this overrides the course one (when the RSVP toggle is OFF this parameter will be ignored). Allowed values: null, false, true. Default value is null"}},"required":["name","max_enroll","evaluation_type"]},"CourseSessionsBatchImportSessionsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Result of action (insert/update) of every single row of provided data","items":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseSessionsBatchImportSessionsData":{"required":["row_index","success","message"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of operation"},"message":{"type":"string","description":"Returned additional info for status of operation"}}},"CourseSessionsBatchImportSessionsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseSessionsBatchImportSessionsLast","description":"Link to the last page"}}},"CourseSessionsBatchImportSessionsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseSessionsBatchImportSessionsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseSessionsBatchImportSessionsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseSessionsBatchImportSessionsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseSessionsListRsvpForUserResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsListRsvpForUserData","description":"Session listing API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/CourseSessionsListRsvpForUserLinks"}}}},"CourseSessionsListRsvpForUserData":{"required":["items","count","has_more_data","current_page","current_page_size","total_page_count","total_count"],"properties":{"items":{"type":"array","description":"Array of Events","items":{"$ref":"#/definitions/CourseSessionsListRsvpForUserItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"}}},"CourseSessionsListRsvpForUserItems":{"required":["id","name","date","time","break","duration","venue","webinar_tool","user_rsvp"],"properties":{"id":{"type":"integer","description":"ID of the event"},"name":{"type":"string","description":"Name of the event"},"date":{"type":"string","format":"date","description":"Start date of the event"},"time":{"type":"string","description":"Duration in hours of the event &quot;9:00 - 18:00 (GMT +02:00 Europe/Rome)&quot;"},"break":{"type":"string","description":"Duration in hours of the break event  &quot;0:00 - 0:00&quot;"},"duration":{"type":"string","description":"Duration in hours of the event &quot;9h 00m&quot;"},"venue":{"type":"string","description":"Event Location, can be null"},"webinar_tool":{"type":"boolean","description":"Check if the event has a webinar tool"},"user_rsvp":{"type":"integer","description":"Response from user &quot;0=awaiting, 1=no, 2=maybe, 3=yes&quot;"}}},"CourseSessionsListRsvpForUserLinks":{},"CourseSessionsListAllIltSessionsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/CourseSessionsListAllIltSessionsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"CourseSessionsListAllIltSessionsData":{"required":["items"],"properties":{"items":{"type":"array","description":"The array of items.","items":{"$ref":"#/definitions/CourseSessionsListAllIltSessionsItems"}}}},"CourseSessionsListAllIltSessionsItems":{"required":["session_id","name","date_start","date_end","course_id","last_update"],"properties":{"session_id":{"type":"integer","description":"The id of the vilt session."},"name":{"type":"string","description":"The name of the vilt session."},"date_start":{"type":"string","description":"The start date (datetime) of the vilt session."},"date_end":{"type":"string","description":"The end date (datetime) of the vilt session."},"course_id":{"type":"integer","description":"The id of the course related to the vilt session."},"last_update":{"type":"string","description":"The last update (datetime) of the vilt session."}}},"CourseThumbnailsDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response","items":{"$ref":"#/definitions/CourseThumbnailsDeleteData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseThumbnailsDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseThumbnailsDeleteData":{},"CourseThumbnailsDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseThumbnailsDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseThumbnailsDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseThumbnailsDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseThumbnailsDeleteLast","description":"Link to the last page"}}},"CourseThumbnailsDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseThumbnailsDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseThumbnailsDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseThumbnailsDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseThumbnailsIndexResponse":{"required":["data","version","version","version","_links","version","version"],"properties":{"data":{"$ref":"#/definitions/CourseThumbnailsIndexData","description":"Courses thumbnails listing API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseThumbnailsIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"},"extra_data":{"$ref":"#/definitions/CourseThumbnailsIndexExtraData","description":"Array with extra data"}}},"CourseThumbnailsIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of courses thumbnails","items":{"$ref":"#/definitions/CourseThumbnailsIndexItems"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page"},"current_page":{"type":"integer","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"Number of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages returned"},"total_count":{"type":"integer","description":"Total number of Items"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/CourseThumbnailsIndexSort"}}}},"CourseThumbnailsIndexItems":{"required":["id","url","filename","created_on"],"properties":{"id":{"type":"integer","description":"ID of the thumbnail"},"url":{"type":"string","description":"URL of the thumbnail"},"filename":{"type":"string","description":"File name"},"created_on":{"type":"integer","description":"UNIX timestamp of when the image was uploaded"},"created_by":{"type":"integer","description":"ID of the user who uploaded this image. Is empty for images uploaded through legacy course management"},"mutlidomain_id":{"type":"integer","description":"The internal ID of the multidomain node, where the image was uploaded. Will be empty for root and old images"},"actions":{"type":"array","description":"The list of actions that the current user can do over the item. Possible values: &#039;edit&#039;, &#039;usage&#039;, &#039;copy_to_multidomain&#039;, &#039;download&#039; and &#039;delete&#039;","items":{"type":"string"}}}},"CourseThumbnailsIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["id"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"CourseThumbnailsIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/CourseThumbnailsIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/CourseThumbnailsIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseThumbnailsIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseThumbnailsIndexLast","description":"Link to the last page"}}},"CourseThumbnailsIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseThumbnailsIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseThumbnailsIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseThumbnailsIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"CourseThumbnailsIndexExtraData":{"required":["current_thumbnail_id"],"properties":{"current_thumbnail_id":{"type":"integer","description":"ID of the current course thumbnail"}}},"CourseThumbnailsUpdateSchema":{"type":"object","properties":{"name":{"type":"string","description":"The name of the thumbnail"}}},"CourseThumbnailsUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseThumbnailsUpdateData","description":"response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/CourseThumbnailsUpdateLinks"}}}},"CourseThumbnailsUpdateData":{"properties":{"success":{"type":"boolean","description":"true if the operation succeeded"},"message":{"type":"string","description":"Error messages, if any"}}},"CourseThumbnailsUpdateLinks":{},"CourseThumbnailsViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseThumbnailsViewData","description":"response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/CourseThumbnailsViewLinks"}}}},"CourseThumbnailsViewData":{"required":["id","url","filename","original_filename","created_on","used_by_count","actions"],"properties":{"id":{"type":"integer","description":"ID of image from type courselogo, course_cover, playerbg, course_original_image"},"url":{"type":"string","description":"URL of the thumbnail"},"filename":{"type":"string","description":"A human readable filename that can be overwritten by the update API"},"original_filename":{"type":"string","description":"The filename with with the image is stored in the cloud storage"},"created_on":{"type":"integer","description":"UNIX timestamp of when the image was uploaded"},"filesize":{"type":"integer","description":"The file size in bytes."},"height":{"type":"integer","description":"The file resolution height."},"width":{"type":"integer","description":"The file resolution width."},"built_in":{"type":"boolean","description":"Indicates that the image is a built in one"},"created_by":{"$ref":"#/definitions/CourseThumbnailsViewCreatedBy","description":"An object representing the &quot;author&quot; of the image. Notice that this will be null for old images"},"multidomain":{"$ref":"#/definitions/CourseThumbnailsViewMultidomain","description":"An object representing the Multidomain node, where the image was originally uploaded. Empty if the image was uploaded at the root."},"used_by_count":{"type":"integer","description":"The count of the items (Courses or Learning plans) that are using the image based on the image type. It holds the full count of the items and does not have any PU visibility filters."},"actions":{"type":"array","description":"An array of possible actions that the current API caller may take over the given resource. Possible values: &#039;edit&#039;, &#039;usage&#039;, &#039;copy_to_multidomain&#039;, &#039;download&#039;, &#039;delete&#039;","items":{"type":"string"}}}},"CourseThumbnailsViewCreatedBy":{"required":["id","firstname","lastname","username"],"properties":{"id":{"type":"integer","description":"The internal ID of the user"},"firstname":{"type":"string","description":"The first name of the user"},"lastname":{"type":"string","description":"The first name of the user"},"username":{"type":"string","description":"The username of the user"}}},"CourseThumbnailsViewMultidomain":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"The internal ID of the multidomain node"},"name":{"type":"string","description":"The name of the multidomain node"}}},"CourseThumbnailsViewLinks":{},"CourseThumbnailsCloneSchema":{"type":"object","required":["target_multidomain"],"properties":{"target_multidomain":{"type":"integer","description":"Multidomain ID that the cloned thumbnail should be assigned"}}},"CourseThumbnailsCloneResponse":{"required":["_links","version","data","version"],"properties":{"_links":{"type":"array","description":"Links to related resources.","items":{"$ref":"#/definitions/CourseThumbnailsCloneLinks"}},"version":{"type":"string","required":"required","description":"Current API version"},"data":{"$ref":"#/definitions/CourseThumbnailsCloneData","description":"response"}}},"CourseThumbnailsCloneLinks":{},"CourseThumbnailsCloneData":{"required":["id"],"properties":{"id":{"type":"integer","description":"ID of the newly created thumbnail"}}},"CourseThumbnailsUsageResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/CourseThumbnailsUsageData","description":"response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/CourseThumbnailsUsageLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"CourseThumbnailsUsageData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size","total_page_count","total_count","sort"],"properties":{"items":{"type":"array","description":"The list of Courses and Learning plans the thumbnail is attached to. The value can be empty array if the thumbnail/cover/playerbg is not used by any Course or Learning plan.","items":{"$ref":"#/definitions/CourseThumbnailsUsageItems"}},"count":{"type":"integer","description":"Total number of items returned."},"has_more_data":{"type":"boolean","description":"True if the current page is not the last page."},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters. Its value could be null. For example when get_cursor = 0."},"current_page":{"type":"integer","description":"Page index number of the current page (starting from 1)."},"current_page_size":{"type":"integer","description":"Number of items per page."},"total_page_count":{"type":"integer","description":"Total number of pages."},"total_count":{"type":"integer","description":"Total number of items."},"sort":{"type":"array","description":"Array of applied sorting fields.","items":{"$ref":"#/definitions/CourseThumbnailsUsageSort"}}}},"CourseThumbnailsUsageItems":{"required":["id","code","name","type"],"properties":{"id":{"type":"integer","description":"The ID of the Course or Learning plan."},"code":{"type":"string","description":"The code of Course or Learning plan."},"name":{"type":"string","description":"The Course or Learning plan title."},"type":{"description":"The type of the Course. If item is Learning plan the value is &#039;learning_plan&#039;.","enum":["elearning","classroom","learning_plan"],"type":"string"}}},"CourseThumbnailsUsageSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name.","enum":["id","code","name"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending.","enum":["asc","desc"],"type":"string"}}},"CourseThumbnailsUsageLinks":{"required":["self","goto"],"properties":{"self":{"$ref":"#/definitions/CourseThumbnailsUsageSelf","description":"Link to the current page"},"next":{"$ref":"#/definitions/CourseThumbnailsUsageNext","description":"Link to the next page"},"prev":{"$ref":"#/definitions/CourseThumbnailsUsagePrev","description":"Link to the previous page"},"goto":{"$ref":"#/definitions/CourseThumbnailsUsageGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/CourseThumbnailsUsageFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/CourseThumbnailsUsageLast","description":"Link to the last page"}}},"CourseThumbnailsUsageSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"CourseThumbnailsUsageNext":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the next page"}}},"CourseThumbnailsUsagePrev":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the previous page"}}},"CourseThumbnailsUsageGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"CourseThumbnailsUsageFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"CourseThumbnailsUsageLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}}}}