{"swagger":"2.0","host":false,"tags":[{"name":"Ai","description":"Manage the AI brain endpoints"},{"name":"Assignment","description":"Assignments related APIs"},{"name":"Callback","description":"Callback APIs (returning calls from external parties, like Transcoder, Cloudconvert,...) related to learning process"},{"name":"CatalogContent","description":"Catalog content related APIs"},{"name":"Catalogue","description":"Catalogue management related APIs"},{"name":"Categories","description":"Category management related APIs"},{"name":"Certification","description":"Course management related APIs"},{"name":"ChannelDashboard","description":"Manipulate the channels "},{"name":"Classroom","description":"Classroom manipulation and management"},{"name":"Clor","description":"Central repository related APIs"},{"name":"Course","description":"Course management related APIs"},{"name":"Coursedesc","description":"Course Description related APIs"},{"name":"Coursefield","description":"Manipulates the Course Additional Fields"},{"name":"Csp","description":"CspController"},{"name":"Enrollment","description":"Managing the course user enrollment"},{"name":"ExternalTraining","description":"Managing the external training"},{"name":"Formetris","description":"Formetris integration related APIs"},{"name":"Forum","description":"Forum Data related APIs"},{"name":"Ilt","description":"Ilt management related APIs"},{"name":"Instructor","description":"Instructor related APIs"},{"name":"Lo","description":"Learning object related APIs"},{"name":"Location","description":"Location related APIs"},{"name":"Lp","description":"Learning Plan related APIs"},{"name":"Pu","description":"Managing power users"},{"name":"Questionbank","description":"Controller serves for TM repo question bank API."},{"name":"Recovery","description":"Callback endpoint to create/update learner track session"},{"name":"Seo","description":"This Controller serves the API to manage seo pages"},{"name":"Sitemap","description":"This Controller serves the API to generate sitemap"},{"name":"SubscriptionBundle","description":"Subscription bundle management related APIs"},{"name":"SubscriptionField","description":"Subscription fields management related APIs"},{"name":"SubscriptionPlan","description":"Subscription plan related APIs"},{"name":"SubscriptionRecord","description":"Subscription record management related APIs"},{"name":"SubscriptionSeatAssociation","description":"Subscription seat associations management related APIs"},{"name":"Survey","description":"Manipulates the survey"},{"name":"Tests","description":"API for instructor tests evaluation"},{"name":"Track","description":"Callback endpoint to create/update learner track session"},{"name":"User","description":"Manipulates the users"},{"name":"Webinar","description":"Webinar manipulation and management"},{"name":"Xapi","description":"LRS management"}],"info":{"title":"Learn","version":"1.0","description":""},"paths":{"/learn/v1/assignment/upload/status":{"get":{"tags":["Assignment"],"operationId":"Assignment./learn/v1/assignment/upload/status","parameters":[{"in":"query","name":"filename","type":"string","required":true,"description":"The Screen-Recording filename"}],"summary":"Checks if a specific Screen-Recording video uploaded as assignment Learning Object exists.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnAssignmentUploadStatusResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Filename parameter is not provided"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/callback/transcoder/{hash_id}":{"post":{"tags":["Callback"],"operationId":"Callback./learn/v1/callback/transcoder/{hash_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCallbackTranscoderSchema"}}],"summary":"Handle Elastic Transcoder generated/initiated callbacks","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCallbackTranscoderResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid hash ID","1002":"Missing resource type"}},"500":{"description":"Internal server error"}}}},"/learn/v1/catalog_content/public/{catalog_id}":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/public/{catalog_id}","parameters":[{"in":"path","name":"catalog_id","type":"integer","required":true,"description":"The id of the catalog"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page number of the current page. Default=0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of items per page. Default=50"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom", "elearning", "mobile", "learning_plan")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter by Price (0 - Free, 1 - Paid). This search can be done only if 'EcommerceApp' is active"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language","type":"array","required":false,"description":"Filter by Language (e.g. ['en', 'it'] will return english and italian courses only)"},{"in":"query","name":"category_id","type":"integer","required":false,"description":"Filter by Category ID. Returns only courses belonging to the given category or its subcategories"},{"in":"query","name":"duration_from_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or greater than the provided value"},{"in":"query","name":"duration_to_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or less than the provided value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"content_partners","type":"array","required":false,"description":"Filter by Content Partner ids"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter results by name, code, description, course uid and text course additional fields"},{"in":"query","name":"field_xx","type":"array","required":false,"description":"Filter courses that only contain one of the given values for the additional field xx (xx being the field's id)"}],"summary":"Retrieves content of the given catalog","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"}}}},"/learn/v1/catalog_content/public/preview":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/public/preview","parameters":[{"in":"query","name":"cursor","type":"integer","required":true,"description":"Offset of the first catalog to return. Default=0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of catalogs per page. Default=50"},{"in":"query","name":"items_per_catalog","type":"integer","required":false,"description":"Number of items retrieved for each catalog."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalogIds","type":"array","required":false,"description":"Filter catalogs by ID."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalog_ids","type":"array","required":false,"description":"Filter catalogs by ID."}],"summary":"Retrieves some content for all the given catalogs","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"}}}},"/learn/v1/catalog_content/public":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/public","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"Page number of the current page. Default=0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of catalogs per page. Default=50"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalogIds","type":"array","required":false,"description":"Filter catalogs by ID."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalog_ids","type":"array","required":false,"description":"Filter catalogs by ID."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom", "elearning", "mobile", "learning_plan")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter by Price (0 - Free, 1 - Paid). This search can be done only if 'EcommerceApp' is active"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language","type":"array","required":false,"description":"Filter by Language (e.g. ['en', 'it'] will return english and italian courses only)"},{"in":"query","name":"category_id","type":"integer","required":false,"description":"Filter by Category ID. Returns only courses belonging to the given category or its subcategories"},{"in":"query","name":"duration_from_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or greater than the provided value"},{"in":"query","name":"duration_to_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or less than the provided value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"content_partners","type":"array","required":false,"description":"Filter by Content Partner ids"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter results by name, code, description, course uid and text course additional fields"},{"in":"query","name":"field_xx","type":"array","required":false,"description":"Filter courses that only contain one of the given values for the additional field xx (xx being the field's id)"}],"summary":"Retrieves content of all the given catalogs","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"}}}},"/learn/v1/catalog_content/public/general":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/public/general","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"Page number of the current page. Default=0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of items per page. Default=50"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom", "elearning", "mobile", "learning_plan")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter by Price (0 - Free, 1 - Paid). This search can be done only if 'EcommerceApp' is active"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language","type":"array","required":false,"description":"Filter by Language (e.g. ['en', 'it'] will return english and italian courses only)"},{"in":"query","name":"category_id","type":"integer","required":false,"description":"Filter by Category ID. Returns only courses belonging to the given category or its subcategories"},{"in":"query","name":"duration_from_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or greater than the provided value"},{"in":"query","name":"duration_to_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or less than the provided value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"content_partners","type":"array","required":false,"description":"Filter by Content Partner ids"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter results by name, code, description, course uid and text course additional fields"},{"in":"query","name":"field_xx","type":"array","required":false,"description":"Filter courses that only contain one of the given values for the additional field xx (xx being the field's id)"}],"summary":"Retrieves all the visible content of the general catalog","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentPublicGeneralCatalogContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog_content/internal/calendar":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/internal/calendar","parameters":[{"in":"query","collectionFormat":"brackets","items":{"type":"int"},"name":"catalog_ids","type":"array","required":false,"description":""},{"in":"query","name":"page","type":"integer","required":false,"description":""},{"in":"query","name":"page_size","type":"integer","required":false,"description":""},{"in":"query","name":"date_start","type":"date","required":false,"description":"Filter by start date. Expected format of date is "2015-06-25 03:30:00""},{"in":"query","name":"date_end","type":"date","required":false,"description":"Filter by end date. Expected format of date is "2015-06-25 03:30:00""},{"in":"query","enum":["course_id","course_type","course_name","date_start","date_end"],"name":"sort_attr","type":"string","required":false,"description":""},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":""},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom")"},{"in":"query","name":"lang","type":"string","required":false,"description":""},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":""}],"summary":"Retrieves all the visible content of given catalogs for the calendar widget","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarCatalogsContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/learn/v1/catalog_content/internal/{catalog_id}":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/internal/{catalog_id}","parameters":[{"in":"path","name":"catalog_id","type":"integer","required":true,"description":"The id of the catalog"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page number of the current page. Default=0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of items per page. Default=50"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom", "elearning", "mobile", "learning_plan")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter by Price (0 - Free, 1 - Paid). This search can be done only if 'EcommerceApp' is active"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language","type":"array","required":false,"description":"Filter by Language (e.g. ['en', 'it'] will return english and italian courses only)"},{"in":"query","name":"category_id","type":"integer","required":false,"description":"Filter by Category ID. Returns only courses belonging to the given category or its subcategories"},{"in":"query","name":"duration_from_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or greater than the provided value"},{"in":"query","name":"duration_to_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or less than the provided value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"content_partners","type":"array","required":false,"description":"Filter by Content Partner ids"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter results by name, code, description, course uid and text course additional fields"},{"in":"query","name":"field_xx","type":"array","required":false,"description":"Filter courses that only contain one of the given values for the additional field xx (xx being the field's id)"},{"in":"query","name":"user_is_not_enrolled","type":"boolean","required":false,"description":"Whether to only retrieve courses and LPs the user is not enrolled to. Default=false"}],"summary":"Retrieves content of the given catalog","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/learn/v1/catalog_content/internal/preview":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/internal/preview","parameters":[{"in":"query","name":"cursor","type":"integer","required":true,"description":"Offset of the first catalog to return. Default=0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of catalogs per page. Default=50"},{"in":"query","name":"items_per_catalog","type":"integer","required":false,"description":"Number of items retrieved for each catalog."},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalogIds","type":"array","required":false,"description":"Filter catalogs by ID."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalog_ids","type":"array","required":false,"description":"Filter catalogs by ID."},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter catalog content by paid / free status"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom", "elearning", "mobile", "learning_plan")"},{"in":"query","name":"virtual_catalogs","type":"integer","required":false,"description":"Request virtual catalogs too from marketplace. If = 1 - show virtual catalogs assigned to the user."}],"summary":"Retrieves some content for all the given catalogs","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/learn/v1/catalog_content/internal":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/internal","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"Page number of the current page. Default=0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of catalogs per page. Default=50"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom", "elearning", "mobile", "learning_plan")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter by Price (0 - Free, 1 - Paid). This search can be done only if 'EcommerceApp' is active"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language","type":"array","required":false,"description":"Filter by Language (e.g. ['en', 'it'] will return english and italian courses only)"},{"in":"query","name":"category_id","type":"integer","required":false,"description":"Filter by Category ID. Returns only courses belonging to the given category or its subcategories"},{"in":"query","name":"duration_from_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or greater than the provided value"},{"in":"query","name":"duration_to_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or less than the provided value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"content_partners","type":"array","required":false,"description":"Filter by Content Partner ids"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter results by name, code, description, course uid and text course additional fields"},{"in":"query","name":"field_xx","type":"array","required":false,"description":"Filter courses or learning plans that only contain one of the given values for the additional field xx (xx being the field's id)"},{"in":"query","name":"user_is_not_enrolled","type":"boolean","required":false,"description":"Whether to only retrieve courses and LPs the user is not enrolled to. Default=false"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalogIds","type":"array","required":false,"description":"Filter catalogs by ID."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalog_ids","type":"array","required":false,"description":"Filter catalogs by ID."},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"course_ids","type":"array","required":false,"description":"Shows only catalogs with these courses."}],"summary":"Retrieves content of all the given catalogs","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/learn/v1/catalog_content/internal/general":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/internal/general","parameters":[{"in":"query","name":"page","type":"integer","required":false,"description":"Page number of the current page. Default=0"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of items per page. Default=50"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom", "elearning", "mobile", "learning_plan")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter by Price (0 - Free, 1 - Paid). This search can be done only if 'EcommerceApp' is active"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"language","type":"array","required":false,"description":"Filter by Language (e.g. ['en', 'it'] will return english and italian courses only)"},{"in":"query","name":"category_id","type":"integer","required":false,"description":"Filter by Category ID. Returns only courses belonging to the given category or its subcategories"},{"in":"query","name":"duration_from_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or greater than the provided value"},{"in":"query","name":"duration_to_seconds","type":"integer","required":false,"description":"Filter by Course duration - get the courses with duration equal or less than the provided value"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"content_partners","type":"array","required":false,"description":"Filter by Content Partner ids"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter results by name, code, description, course uid and text course additional fields"},{"in":"query","name":"field_xx","type":"array","required":false,"description":"Filter courses or learning plans that only contain one of the given values for the additional field xx (xx being the field's id)"},{"in":"query","name":"user_is_not_enrolled","type":"boolean","required":false,"description":"Whether to only retrieve courses and LPs the user is not enrolled to. Default=false"}],"summary":"Retrieves all the visible general catalog content for the current user","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentInternalGeneralCatalogContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/learn/v1/catalog_content/public/calendar/general":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/public/calendar/general","parameters":[{"in":"query","name":"date_start","type":"date","required":false,"description":"The date from which the event should start (format "YYYY-MM-DD HH:MM:SS")"},{"in":"query","name":"date_end","type":"date","required":false,"description":"The date to which the event should end (format "YYYY-MM-DD HH:MM:SS")"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter for only paid/free courses"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Page size"},{"in":"query","enum":["course_id","course_type","course_name","date_start","date_end"],"name":"sort_attr","type":"string","required":false,"description":"Sort attribute"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sort direction"}],"summary":"Retrieves content of the calendar of courses in public general catalog","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarGeneralCatalogsContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog_content/public/calendar":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/public/calendar","parameters":[{"in":"query","collectionFormat":"brackets","items":{"type":"int"},"name":"catalog_ids","type":"array","required":false,"description":""},{"in":"query","name":"date_start","type":"date","required":false,"description":"The date from which the event should start (format "YYYY-MM-DD HH:MM:SS")"},{"in":"query","name":"date_end","type":"date","required":false,"description":"The date to which the event should end (format "YYYY-MM-DD HH:MM:SS")"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter for only paid/free courses"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Page size"},{"in":"query","enum":["course_id","course_type","course_name","date_start","date_end"],"name":"sort_attr","type":"string","required":false,"description":"Sort attribute"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sort direction"}],"summary":"Retrieves all the visible content of given catalogs for the calendar widget","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarCatalogsContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog_content/internal/calendar/general":{"get":{"tags":["CatalogContent"],"operationId":"CatalogContent./learn/v1/catalog_content/internal/calendar/general","parameters":[{"in":"query","name":"date_start","type":"date","required":false,"description":"The date from which the event should start (format "YYYY-MM-DD HH:MM:SS")"},{"in":"query","name":"date_end","type":"date","required":false,"description":"The date to which the event should end (format "YYYY-MM-DD HH:MM:SS")"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filter by Type ("classroom")"},{"in":"query","name":"is_paid","type":"boolean","required":false,"description":"Filter for only paid/free courses"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Page size"},{"in":"query","enum":["course_id","course_type","course_name","date_start","date_end"],"name":"sort_attr","type":"string","required":false,"description":"Sort attribute"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sort direction"}],"summary":"Retrieves content of the calendar of courses in internal general catalog for the logged user","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarGeneralCatalogsContentResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Error while processing the requested operation","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/learn/v1/catalog/filters":{"get":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/filters","parameters":[{"in":"query","name":"catalog_id","type":"integer","required":false,"description":"Id of the given catalog. Value 0 or empty value returns categories from generic catalog"},{"in":"query","name":"hide_course_types","type":"boolean","required":false,"description":"Hide filter by course type. Default value: 'FALSE'"},{"in":"query","name":"my_courses","type":"boolean","required":false,"description":"If it is set to 'true', filter by enrollment status is not returned in results. This filter is returned only if API is called by logged user. Default value: 'false'"},{"in":"query","name":"show_language","type":"boolean","required":false,"description":"If it is set to 'false', language filter is not returned in results. Default value: 'true'"}],"summary":"Retrieves all catalog filter options","last_modified_date":"2024.01.16","description":"All the catalog filter options retrieved do not take into account the caller's visibility over the courses","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueFiltersResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Something went wrong!","1001":"Catalog not found","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"}}}},"/learn/v1/catalog/internal_filters":{"get":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/internal_filters","parameters":[{"in":"query","name":"catalog_id","type":"integer","required":false,"description":"Id of the given catalog. Value 0 or empty value returns categories from generic catalog"},{"in":"query","name":"hide_course_types","type":"boolean","required":false,"description":"Hide filter by course type. Default value: 'FALSE'"},{"in":"query","name":"my_courses","type":"boolean","required":false,"description":"If it is set to 'true', filter by enrollment status is not returned in results. This filter is returned only if API is called by logged user. Default value: 'false'"}],"summary":"Retrieves all catalog filter options","last_modified_date":"","description":"All the catalog filter options retrieved do not take into account the caller's visibility over the courses","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueInternalFiltersResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Something went wrong!","1001":"Catalog not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog/webpages":{"get":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/webpages","parameters":[],"summary":"Retrieves webpages to be displayed as public catalog pages","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueWebpagesResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Something went wrong!"}},"500":{"description":"Internal server error"}}}},"/learn/v1/catalog/batch":{"post":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCatalogueBatchImportSchema"}}],"summary":"Batch import catalogs","last_modified_date":"2024.07.25","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueBatchImportResponse"}},"400":{"description":"General Error","error_codes":{"1102":"Please provide valid parameters for an API call","1103":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog/items/batch":{"post":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/items/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCatalogueBatchItemsSchema"}}],"summary":"Batch import catalogue items","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueBatchItemsResponse"}},"400":{"description":"General Error","error_codes":{"1102":"Please provide valid parameters for an API call","1103":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog/assignments/batch":{"post":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/assignments/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCatalogueBatchVisibilitySchema"}}],"summary":"Batch import catalogue visibility","last_modified_date":"2024.07.25","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueBatchVisibilityResponse"}},"400":{"description":"General Error","error_codes":{"1102":"Please provide valid parameters for an API call","1103":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog/{catalog_id}/course/{course_id}":{"post":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/{catalog_id}/course/{course_id}","parameters":[{"in":"path","name":"catalog_id","type":"integer","required":true,"description":"Catalogue's Id"},{"in":"path","name":"course_id","type":"integer","required":true,"description":"Course's Id"}],"summary":"Import courses (and courses only) into a catalog","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueAddCourseToCatalogResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameters","1002":"Invalid parameter: {X}","1003":"Course with code ‘{X}’ already assigned to Catalogue with code ‘{Y}’ and was skipped"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/{catalog_id}/course/{course_id}","parameters":[{"in":"path","name":"catalog_id","type":"integer","required":true,"description":"Catalogue's Id"},{"in":"path","name":"course_id","type":"integer","required":true,"description":"Course's Id"}],"summary":"Remove course form a catalog","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueDeleteCourseFromCatalogResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameters"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog/course/batch":{"post":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/course/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsSchema"}}],"summary":"Batch add courses in catalogs","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/catalog/advanced_filters":{"get":{"tags":["Catalogue"],"operationId":"Catalogue./learn/v1/catalog/advanced_filters","parameters":[{"in":"query","name":"catalog_id","type":"integer","required":false,"description":"Id of the given catalog. Value 0 or empty value returns categories from generic catalog"},{"in":"query","name":"my_courses","type":"boolean","required":false,"description":"Either to show or hide the filter for courses where the user is enrolled"},{"in":"query","name":"get_duration_filter","type":"boolean","required":false,"description":"Either to show or hide the filter for course duration"}],"summary":"Retrieves all advanced filter options by catalog ID","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Something went wrong!","1001":"Catalog not found"}},"500":{"description":"Internal server error"}}}},"/learn/v1/categories":{"get":{"tags":["Categories"],"operationId":"Categories./learn/v1/categories","parameters":[{"in":"query","name":"node_id","type":"integer","required":false,"description":"ID of the category, when passed as 0 the API will consider it as the root node id"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the category title."},{"in":"query","name":"for_catalog_filter","type":"integer","required":false,"description":"If 1, get all categories which has at least 1 course or learning plan assigned. It uses in catalog filters"},{"in":"query","name":"catalog_id","type":"integer","required":false,"description":"If catalog_id is present, the categories will be filtered by the items in that catalogue."},{"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 to the platform setting for pagination"},{"in":"query","enum":["id","title"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction. Default - asc"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor"},{"in":"query","name":"search_type","type":"integer","required":false,"description":"Search for category by provided `search_text` and type of the result: 1: anywhere; 2- in current category; 3 - in current category and all descendant categories"},{"in":"query","name":"visible_by","type":"integer","required":false,"description":"Get categories visible only by particular user (Power user)"},{"in":"query","name":"assigned_only","type":"boolean","required":false,"description":"If visible_by is passed, whether to skip the categories inherited by courses."},{"in":"query","name":"only_subscriptions","type":"integer","required":false,"description":"If 1, get categories from subscriptions"}],"summary":"Retrieves all categories","last_modified_date":"2023.04.03","description":"All filter parameters are optional. If catalog_id is present, the categories will be filtered by the items in that catalogue.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCategoriesIndexResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Something went wrong!"}},"500":{"description":"Internal server error"}}}},"/learn/v1/categories/{id}":{"get":{"tags":["Categories"],"operationId":"Categories./learn/v1/categories/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"Id of the parent category."},{"in":"query","name":"data_provider","type":"integer","required":false,"description":"Whether the result to be returned as data provider or not. Accepts only 0 and 1. Default = 0."}],"summary":"Retrieves all child categories by ID of parent category","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCategoriesViewChildsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Category not found","1002":"Category does not have child categories","1003":"Invalid parameter: data_provider"}},"500":{"description":"Internal server error"}}}},"/learn/v1/certification":{"get":{"tags":["Certification"],"operationId":"Certification./learn/v1/certification","parameters":[{"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 10"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sorting the result by column name - 'id', 'title' or 'description'; Default - 'title'"},{"in":"query","name":"sort_dir","type":"string","required":false,"description":"Sorting direction - can be 'ASC' or 'DESC'; Default - ASC"},{"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 "cursor" and prebuilt navigational "_links". Default=0"},{"in":"query","name":"filters","type":"string","required":false,"description":"URL encoded serialized object containing list of filters and their options. List of filters - ( title:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains}, description:{like, contains, not_equal, ends_with, starts_with, is_empty, not_empty, not_start_with, not_end_with, not_contains} )"}],"summary":"Returns all certifications.","last_modified_date":"","description":"All filter parameters are optional. If both title is searched, then the filters value looks like this: [{\"title\":{\"option\":\"contains\",\"value\":\"search string goes here\"}}]","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCertificationIndexResponse"}},"500":{"description":"Internal server error"}}}},"/learn/v1/certification/batch":{"post":{"tags":["Certification"],"operationId":"Certification./learn/v1/certification/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCertificationBatchImportSchema"}}],"summary":"Batch import of user certifications","last_modified_date":"2022.08.03","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCertificationBatchImportResponse"}},"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"}}}},"/learn/v1/certification/importer_fields\r":{"get":{"tags":["Certification"],"operationId":"Certification./learn/v1/certification/importer_fields\r","parameters":[],"summary":"Returns list of mappable fields for the data importer\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCertificationImporterFieldsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid entity type\r","1002":"The course doesn't exist\r","1003":"Do not have the needed permissions\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/{channel_id}/assets":{"get":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/{channel_id}/assets","parameters":[{"in":"path","name":"channel_id","type":"integer","required":true,"description":"ID of the channel"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the asset title. Default empty string"},{"in":"query","enum":["title","created"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: 'asc' = Ascending, 'desc' = descending. 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, default 200, if value is -1 -> all items are displayed"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"show","type":"string","required":false,"description":"Filter by date time. If passed, you can only see the contents inserted in that specific time frame. Options: 'any', 'day', 'week', 'month', 'year'. Default: 'any'"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"status","type":"array","required":false,"description":"Filter by status. Options: 0-not_started, 1-in_progress, 2-completed. Default: all"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"type","type":"array","required":false,"description":"Filter by type. Options: 1-E-learning, 2-Classroom, 4-Learning Plans, 16-Certification (requires New Certifications feature), if we have active share app we have also options: 5-Video, 6-Documents, 7-GDrive, 8-Image, 9-Links, 10-PDF, 11-Audio, 12-Others, 13-Playlist, 14-External. Default: all"},{"in":"query","name":"deadline","type":"string","required":false,"description":"Filter by deadline. Options: 'any', 'day', 'week', 'month', 'year'. Default: all"},{"in":"query","name":"duration","type":"string","required":false,"description":"Filter by duration. Options: 'all', 'short', 'medium', 'long'. Default: all"},{"in":"query","name":"rating","type":"integer","required":false,"description":"Filter by rating. Options: number in interval 1-5. Default: all"},{"in":"query","name":"with_visibility","type":"string","required":false,"description":"Filter by visibility. Options: 'visible', 'hidden', 'both'. Default: 'visible'"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"areas","type":"array","required":false,"description":"Array of area IDs used to filter the content"},{"in":"query","name":"show_loading","type":"boolean","required":false,"description":"Flag to show contributor's assets still in converting. Default: false"},{"in":"query","name":"user_is_not_enrolled","type":"boolean","required":false,"description":"If true, show only courses in which user is not enrolled"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"cohort_groups","type":"array","required":false,"description":"List of groups for cohort visibility"},{"in":"query","enum":["target_level_only","without_target_only"],"name":"skills_target_group","type":"string","required":false,"description":"The group of skills to filter content. This parameter will be ignored if the Skill Gap toggle is not active."}],"summary":"View channel assets","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardViewResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid Channel ID","1001":"You don't have permissions to view this channel","1002":"Invalid parameter: {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels":{"get":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the asset title. Default empty string"},{"in":"query","name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - title. Options: id, title, created, views"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: 'asc' = Ascending, 'desc' = descending. 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, default 200, if value is -1 -> all items are displayed"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"items_per_channel","type":"integer","required":false,"description":"Count of items per channel. Default: 10"},{"in":"query","name":"show","type":"string","required":false,"description":"Filter by date time. If passed, you can only see the contents inserted in that specific time frame. Options: 'any', 'day', 'week', 'month', 'year'. Default: 'any'"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"status","type":"array","required":false,"description":"Filter by status. Options: 0-not_started, 1-in_progress, 2-completed. Default: all"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"type","type":"array","required":false,"description":"Filter by type. Options: 1-E-learning, 2-Classroom, 4-Learning Plans, 16-Certification (requires New Certifications feature), if we have active share app we have also options: 5-Video, 6-Documents, 7-GDrive, 8-Image, 9-Links, 10-PDF, 11-Audio, 12-Others, 13-Playlist, 14-External. Default: all"},{"in":"query","name":"deadline","type":"string","required":false,"description":"Filter by deadline. Options: 'any', 'day', 'week', 'month', 'year'. Default: all"},{"in":"query","name":"duration","type":"string","required":false,"description":"Filter by duration. Options: 'all', 'short', 'medium', 'long'. Default: all"},{"in":"query","name":"rating","type":"integer","required":false,"description":"Filter by rating. Options: number in interval 1-5. Default: all"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor"},{"in":"query","name":"with_visibility","type":"string","required":false,"description":"Filter for content visibility based on logged user. Options: 'visible', 'hidden', 'both'. Default: 'visible'"},{"in":"query","enum":["built-in","custom","ai-based"],"name":"channel_type","type":"string","required":false,"description":"Filter by the type of the channel. Built in = 'built-in', custom = 'custom', AiBased = 'ai-based'"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"areas","type":"array","required":false,"description":"Array of area IDs used to filter the content"},{"in":"query","name":"exclude_channels_info","type":"boolean","required":false,"description":"If the value is true, returns only info of channel items."},{"in":"query","name":"show_loading","type":"boolean","required":false,"description":"Flag to show contributor's assets still in converting. Default: false"},{"in":"query","name":"user_is_not_enrolled","type":"boolean","required":false,"description":"If true, show only courses in which user is not enrolled"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"channels","type":"array","required":false,"description":"Filter by a list of channel IDs"},{"in":"query","name":"only_followed_channels","type":"boolean","required":false,"description":"If true, it only shows channels followed by the user"},{"in":"query","enum":["target_level_only","without_target_only"],"name":"skills_target_group","type":"string","required":false,"description":"The group of skills to filter content. This parameter will be ignored if the Skill Gap toggle is not active."}],"summary":"List of Channels assets","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardListResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid field: X","1002":"Invalid parameter: sort_attr","1003":"Invalid parameter: items_per_channel","0":"Invalid parameter: X"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/unfollow":{"delete":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/unfollow","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnChanneldashboardUnfollowSchema"}}],"summary":"Unfollow a list of channel IDs","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardUnfollowResponse"}},"400":{"description":"General Error","error_codes":{"400":"Missing mandatory params"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/follow":{"post":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/follow","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnChanneldashboardFollowSchema"}}],"summary":"The logged user can follow a list of channels","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardFollowResponse"}},"400":{"description":"General Error","error_codes":{"400":"Missing mandatory params"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/follow/{channel_id}":{"patch":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/follow/{channel_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnChanneldashboardChangeFollowNotificationSchema"}},{"in":"path","name":"channel_id","type":"integer","required":true,"description":"The ID of the followed channel"}],"summary":"Update Notification Of A Followed Channel","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardChangeFollowNotificationResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/{channel_id}/experts":{"get":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/{channel_id}/experts","parameters":[{"in":"path","name":"channel_id","type":"integer","required":true,"description":"ID of the channel"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the asset title. Default empty string"},{"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, default 200, if value is -1 -> all items are displayed"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"}],"summary":"View channel experts","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid Channel ID","1001":"You don't have permissions to view this channel"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/users/{user_id}/content/pending/count":{"get":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/users/{user_id}/content/pending/count","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"Required ID of the user"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"types","type":"array","required":false,"description":"Filter by content type, permitted value: asset, course, external"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"skill_codes","type":"array","required":false,"description":"Filter by an array of skill code"}],"summary":"Retrieve the number of pending content based on the user's visibility","last_modified_date":"","description":"This API can be called by a manager of the provided user, or by the user itself. The external content cannot be more than 50.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardListUserContentPendingCountResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/users/{user_id}/content/completed/count":{"get":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/users/{user_id}/content/completed/count","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"Required ID of the user"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"types","type":"array","required":false,"description":"Filter by content type, permitted value: asset, course, external"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"skill_codes","type":"array","required":false,"description":"Filter by an array of skill code"},{"in":"query","name":"date_begin","type":"string","required":false,"description":"Begin date filtering (format: YYYY-MM). If both date filters are not passed, the default is twelve months ago"},{"in":"query","name":"date_end","type":"string","required":false,"description":"End date filtering (format: YYYY-MM). If both date filters are not passed, the default is the current month"}],"summary":"Retrieve the number of content completed by the user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardListUserContentCompletedCountResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/users/{user_id}/content/courses/time":{"get":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/users/{user_id}/content/courses/time","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"Required ID of the user"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"skill_codes","type":"array","required":false,"description":"Filter by an array of skill code. If not passed, data are filtered by the entire skills list of the user"},{"in":"query","name":"date_begin","type":"string","required":false,"description":"Begin date filtering (format: YYYY-MM). If both date filters are not passed, the default is twelve months ago"},{"in":"query","name":"date_end","type":"string","required":false,"description":"End date filtering (format: YYYY-MM). If both date filters are not passed, the default is this month"}],"summary":"Retrieves the time spent in courses","last_modified_date":"","description":"This API can be called by a manager or the user itself, if the passed user_id is the id of the logged user","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardListUserCoursesTimeSpentResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/users/{user_id}/latest_updates":{"get":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/users/{user_id}/latest_updates","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"The user ID"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"skill_codes","type":"array","required":false,"description":"Filter the results showing only item with these skills"}],"summary":"Show the latest twenty skill updates for the user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardListLatestUpdatesForUserResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/channels/users/{user_id}/content/suggestion/assets":{"get":{"tags":["ChannelDashboard"],"operationId":"ChannelDashboard./learn/v1/channels/users/{user_id}/content/suggestion/assets","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"ID of the user"},{"in":"query","name":"search_text","type":"string","required":false,"description":"The search string, can be a part of a title"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"skill_codes","type":"array","required":false,"description":"Array of skill codes to filter the assets list"},{"in":"query","enum":["id","title","content_type_label"],"name":"sort_attr","type":"string","required":false,"description":"The optional name of the sortable field. The default value is "id"."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"The optional sorting direction. Allowed values are "asc" for ascending or "desc" for descending. The default value is "asc"."},{"in":"query","name":"page","type":"integer","required":false,"description":"The page to return. The default value is "1". This parameter is optional."},{"in":"query","name":"page_size","type":"integer","required":false,"description":"The maximum number of results per page. This parameter is optional."}],"summary":"Retrieve a list of assets that can be suggested by the manager. This API can be called only by a manager of this user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnChanneldashboardListAssetsCanBeSuggestedToUserResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/ilt/session/batch":{"post":{"tags":["Classroom"],"operationId":"Classroom./learn/v1/ilt/session/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnClassroomBatchSessionsSchema"}}],"summary":"Batch import of ILT Sessions and Dates","last_modified_date":"2025.04.17","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnClassroomBatchSessionsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter: items","1001":"Maximum number of records exceeded (100)","1002":"Invalid value for option {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/ilt/session/importer_fields\r":{"get":{"tags":["Classroom"],"operationId":"Classroom./learn/v1/ilt/session/importer_fields\r","parameters":[],"summary":"Returns list of mappable fields for the data importer\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnClassroomImporterFieldsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/classroom":{"post":{"tags":["Classroom"],"operationId":"Classroom./learn/v1/classroom","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnClassroomCreateClassroomSchema"}}],"summary":"Creates a new classroom","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnClassroomCreateClassroomResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter","1002":"Invalid id_location","1003":"Location not found","1004":"Invalid name","1005":"Invalid number of seats"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Classroom"],"operationId":"Classroom./learn/v1/classroom","parameters":[{"in":"query","enum":["id_classroom","id_location","name"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id_classroom"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default is asc. Ignored if sort_attr is not specified."},{"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 10"}],"summary":"Gets the list of classrooms","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnClassroomListClassroomsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/classroom/{id}":{"put":{"tags":["Classroom"],"operationId":"Classroom./learn/v1/classroom/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnClassroomUpdateClassroomSchema"}},{"in":"path","name":"id","type":"int","required":true,"description":"The classroom id"}],"summary":"Updates an existing classroom","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnClassroomUpdateClassroomResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Location not found","1003":"Invalid parameter: {X}","1004":"Invalid name","1005":"Invalid number of seats"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Classroom"],"operationId":"Classroom./learn/v1/classroom/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the classroom to delete"}],"summary":"Deletes a classroom","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnClassroomDeleteClassroomResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter","1002":"Classroom is used in some future session"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Classroom"],"operationId":"Classroom./learn/v1/classroom/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the classroom to view"}],"summary":"Views a classroom","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnClassroomViewClassroomResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseCreateSchema"}}],"summary":"Create a new Course","last_modified_date":"2025.05.14","description":"Classroom course status can be defined only via API. Make sure you set it to 'published' to make the course visible to learners.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseCreateResponse"}},"400":{"description":"General Error","error_codes":{"1004":"Validation error messages"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses","parameters":[{"in":"query","name":"updated_from","type":"datetime","required":false,"description":"Filters all the courses that have been updated after a certain date/time, formatted as "yyyy-mm-dd hh:mm:ss", UTC timezone. Must be less than the current timestamp and lower than updated_to, if specified. Default is empty (not used for filtering)"},{"in":"query","name":"updated_to","type":"datetime","required":false,"description":"Filters all the courses that have been updated before a certain date/time, formatted as "yyyy-mm-dd hh:mm:ss", UTC timezone. Must be less than the current timestamp and greater than updated_from, if specified. Default is empty (not used for filtering)"},{"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 20 (unless the relative parameter in Advanced Settings has been modified)"},{"in":"query","enum":["idCourse","create_date","name","code","course_type","lang_code","status","date_begin","date_end","idCategory","price"],"name":"sort_by","type":"string","required":false,"description":"Sort the result by this column. Options: idCourse, create_date, name, code, course_type, lang_code, status, date_begin, date_end, idCategory, price Default value: create_date"},{"in":"query","enum":["asc","desc"],"name":"sort_by_direction","type":"string","required":false,"description":"Sorting direction: can be 'asc' or 'desc'. If not provided or an invalid value is provided, the parameter will be ignored"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"}],"summary":"Returns all courses.","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid Parameter updated_from","1002":"Invalid Parameter updated_to"}},"500":{"description":"Internal server error"}}}},"/learn/v1/courses/{id}\r":{"delete":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}\r","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the Learning plan\r"}],"summary":"Delete specific Learning course by given ID\r","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter\r","1002":"Invalid course\r","1003":"Failed to delete the object for unknown reason.\r","1004":"Failed to delete the course because it is used in at least one audience rule.\r","1005":"An error occurred\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"},{"in":"query","enum":["0","1"],"name":"get_all_sessions","type":"integer","required":false,"description":"If set to 0 then expired sessions and sessions with max enrollments will be excluded (sessions with overbooking will show). If set to 1 then all sessions, including expired ones, will be retrieved. Default value is 0."}],"summary":"View a Course","last_modified_date":"2025.11.20","description":"The parameter partner_data.logo will be deprecated on 2019-01-19","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseViewResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/los":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/los","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"The id of the course"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search phrase for name column"},{"in":"query","name":"can_score","type":"boolean","required":false,"description":"Search only for LOs that can be applied to score modes"},{"in":"query","enum":["code","name","type","is_public"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, 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. Default to the platform setting for pagination"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"}],"summary":"Get all learning objects by id of course","last_modified_date":"","description":"The API returns Course playable items, in the case of Scorm and AICC it will return their chapters instead of the main learning object entity","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseLosResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/deeplink":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/deeplink","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseDeeplinkSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"}],"summary":"Deeplinking is enabled in the advanced settings of a course and it allows to share a course with anybody using a signed link","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseDeeplinkResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide valid course_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/sessions/{session_id}/deeplink":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/sessions/{session_id}/deeplink","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseSessionDeeplinkSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of the session"}],"summary":"Enroll to a session via its deeplink if enabled","last_modified_date":"2025.04.16","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseSessionDeeplinkResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'generated_by'"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{id}/sessions":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/sessions","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The id of the course"}],"summary":"Get all sessions that the user is enrolled in or all available if not enrolled by id of course","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseSessionsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Invalid course ID"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/rating":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/rating","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"}],"summary":"View course rating","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseRatingResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide valid course_id"}},"500":{"description":"Internal server error"}}}},"/learn/v1/courses/{id}/rating":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/rating","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseUpdateRatingSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"The ID of the course"}],"summary":"Insert course rating","last_modified_date":"2022.05.19","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseUpdateRatingResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Course rating now allowed","1002":"User cannot rate this course","1003":"User already voted","1004":"Operation failure","1005":"Model validation error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/report":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/report","parameters":[{"in":"query","name":"timeframe","type":"string","required":false,"description":"Timeframe filter on enrollment date. Possible values: any, this_year, this_week, this_month, custom (default: this_year)"},{"in":"query","name":"startDate","type":"string","required":false,"description":"Used only when timeframe parameter is set to custom. Start date filter for enrollment date."},{"in":"query","name":"endDate","type":"string","required":false,"description":"Used only when timeframe parameter is set to custom. End date filter for enrollment date."},{"in":"query","name":"timeframe_completion","type":"string","required":false,"description":"Timeframe filter on course completion date. Possible values: this_year, this_week, this_month, custom (default: this_year)"},{"in":"query","name":"startDate_completion","type":"string","required":false,"description":"Used only when timeframe_completion parameter is set to custom. Start date filter for course completion date."},{"in":"query","name":"endDate_completion","type":"string","required":false,"description":"Used only when timeframe_completion parameter is set to custom. End date filter for course completion date."},{"in":"query","name":"hide_deactivated_users","type":"integer","required":false,"description":"If equals to 1 - exclude inactive users, default 0"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"branchIds","type":"array","required":false,"description":"Branches to filter the results by"},{"in":"query","name":"idCourse","type":"integer","required":false,"description":"Parameter for showing results for a single course."},{"in":"query","enum":["0","1"],"name":"export","type":"integer","required":false,"description":"Export data to Excel. Options: 1 - true, 0 - false. Default: 0"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search phrase for Course name column or Enrolled user's username if idCourse parameter is provided."},{"in":"query","enum":["username","first_name","last_name","code","name","enrolled","completed","in_progress","not_started"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, 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. Default to the platform setting for pagination"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor."},{"in":"query","name":"query_id","type":"string","required":false,"description":"The ID of the query"},{"in":"query","name":"next_token","type":"string","required":false,"description":"The token to recover the next chunk of data"}],"summary":"Get enrollment report for a given course or all course, or get the CSV file with the report","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseReportResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Invalid course"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{id}/widgets":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/widgets","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The id of the course"}],"summary":"Get all the widgets that have been set for the specific course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseWidgetsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{id}/comments":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/comments","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The id of the course"},{"in":"query","name":"forum_id","type":"integer","required":true,"description":"The id of the forum"},{"in":"query","name":"discussions_limit","type":"integer","required":false,"description":"Max number of discussions"},{"in":"query","name":"messages_limit","type":"integer","required":false,"description":"Max number of messages"}],"summary":"Get discussions/posts of a course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseCommentsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: course_id | forum_id","1002":"Invalid course ID","1003":"Invalid thread ID"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{id}/comments/thread/{thread_id}":{"put":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/comments/thread/{thread_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseThreadSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"The id of the course"},{"in":"path","name":"thread_id","type":"integer","required":true,"description":"The id of the tread"}],"summary":"PUTdiscussions (thread) - course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseThreadResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Discussion not found","1002":"Error when deleting discussion","1003":"Errors while updating the discussion","1004":"Errors while updating the message","1005":"Invalid parameter: course_id | forum_id","1006":"Invalid course ID","1007":"Missing parameter \"text\"","1008":"Error when deleting learningForumthread","1009":"Permission denied"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{id}/comments/thread/{thread_id}/message":{"put":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/comments/thread/{thread_id}/message","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseMessageSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"The id of the course"},{"in":"path","name":"thread_id","type":"integer","required":true,"description":"The id of the thread course"}],"summary":"Add new message to a forum thread","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseMessageResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Discussion not found","1002":"Missing parameter thread_id","1003":"Thread not found.","1004":"Missing parameter \"content\"."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{id}/comments/thread/message/{id_message}/{thumb_action}":{"put":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/comments/thread/message/{id_message}/{thumb_action}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"id_message","type":"integer","required":true,"description":"ID of the message"},{"in":"path","enum":["like","dislike"],"name":"thumb_action","type":"string","required":true,"description":"Message reaction"}],"summary":"Flag a forum message with a LIKE or DISLIKE","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseThumbForumMessageResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Errors while saving the thumb"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/chart":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/chart","parameters":[{"in":"query","name":"timeframe","type":"string","required":false,"description":"Timeframe type (this_week,this_month,custom) Default : this_year"},{"in":"query","name":"startDate","type":"string","required":false,"description":"Start date which should be used for the filtering"},{"in":"query","name":"endDate","type":"string","required":false,"description":"End date which should be used for the filtering"},{"in":"query","name":"hide_deactivated_users","type":"integer","required":false,"description":"If equals to 1 - exclude inactive users, default 0"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"branchId","type":"array","required":false,"description":"Branches to filter the results by"},{"in":"query","name":"idCourse","type":"string","required":false,"description":"Parameter for showing results for a single course"}],"summary":"Get course enrollment statistic to be used in charts","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseChartResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Invalid course"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/enrollment_pdf":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/enrollment_pdf","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseEnrollmentPdfSchema"}}],"summary":"Download course enrollment statistics PDF file","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseEnrollmentPdfResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid Parameter","1002":"Invalid Course"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/ilt/session/{session_id}":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/ilt/session/{session_id}","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of the session"}],"summary":"Get the full information about the ILT Course Session","last_modified_date":"2025.06.11","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseCourseIltsessionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid course id","1002":"Invalid session ID"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/switch_sessions":{"put":{"tags":["Course"],"operationId":"Course./learn/v1/courses/switch_sessions","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseSwitchSessionsSchema"}}],"summary":"Move an user from one Session to another one","last_modified_date":"2023.10.17","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseSwitchSessionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'X'","2001":"You are not enrolled into the session from which you're trying to un-enroll","2002":"You are not allowed to change sessions.","2003":"There is no valid session for you to select","2004":"You are already enrolled into this session.","2005":"The session is fully booked"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/course/downloadEvaluationFile":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/course/downloadEvaluationFile","parameters":[{"in":"query","name":"session_id","type":"string","required":true,"description":"The id of the session for which the file has to be downloaded"}],"summary":"Download Session Evaluation action for the currently logged user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseDownloadEvaluationFileResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: session_id","1002":"lt_courseuser_session record not found","1003":"lt_courseuser_session does not have an evaluation file"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/clor_lo/{lo_id}":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/clor_lo/{lo_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseAddLosToCourseSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"lo_id","type":"integer","required":true,"description":"ID of the LO"}],"summary":"Adding CLOR LO to Course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseAddLosToCourseResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid course ID","1002":"Invalid repository object ID","1003":"Only course from CSP are allowed","1004":"Invalid LO version params","1005":"Trying to push the same central LO object twice","1006":"Error in course organization root node creation","1007":"Operation failure"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/lo/{org_id}":{"delete":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/lo/{org_id}","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"org_id","type":"integer","required":true,"description":"ID of the learning organization"}],"summary":"Deleting CLOR LOs from course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseDeleteLosFromCourseResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid LO ID","1002":"Invalid Course ID","1003":"Root node deleting is not allowed","1004":"LO is not from Central Repository","1005":"Operation failure"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/clor_lo/batch":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/clor_lo/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseSchema"}}],"summary":"Batch adding CLOR LO to Course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Malformed input data","1002":"Invalid parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/batch":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseBatchImportCoursesSchema"}}],"summary":"Batch import courses","last_modified_date":"2024.08.05","description":"Classroom course status can be defined only via API. Make sure you set it to 'published' to make the course visible to learners.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseBatchImportCoursesResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Maximum number of records exceeded","1002":"Invalid value for option"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/field":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/field","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseCreateFieldSchema"}}],"summary":"Create a course additional field.","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseCreateFieldResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter association","1001":"Invalid parameter type","1002":"Invalid parameter show_field","1003":"Invalid parameter name","1004":"Invalid parameter dropdown_options","1005":"Invalid parameter json_config_filter","1006":"Invalid parameter multi_choice_filter","1007":"Invalid parameter filterable","1008":"Invalid parameter settings.url","1009":"Invalid parameter settings.height","1010":"Invalid parameter settings.columns_catalog","1011":"Invalid parameter settings.columns_widget","1012":"Invalid parameter settings.hash_secret","1013":"Invalid parameter settings.oauth_client_id","1014":"Invalid parameter sequence","1015":"The maximum number of additional fields is {0}, it's not possible to create new fields","1016":"DB operation error","1017":"Operation failed.","1018":"Invalid parameter extra_association","1019":"Invalid parameter mandatory","1022":"Invalid parameter dropdown_options (more than max options allowed for dropdown_multivalue)","1023":"Maximum number of multi-select dropdown additional fields reached","1024":"Invalid parameter settings.filter_logic","1100":"Missing parameter association","1101":"Missing parameter name","1102":"Missing parameter type","1103":"Missing parameter show_field"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/field","parameters":[{"in":"query","name":"name","type":"string","required":false,"description":"Search text in the course field title (searches in all of the title translations)"},{"in":"query","enum":["course","coursepath","course_coursepath","ilt","certification"],"name":"association","type":"string","required":false,"description":"The type of the object associated with the field"},{"in":"query","enum":["date","dropdown","dropdown_multivalue","textfield","textarea","iframe"],"name":"type","type":"string","required":false,"description":"The type of the additional field (note: the 'iframe' type is not supported for ilt; 'dropdown_multivalue' requires the multi-value-dropdown-additional-field toggle to be enabled)"},{"in":"query","name":"show_field","type":"boolean","required":false,"description":"Whether the field is visible or not in the catalog and course page"},{"in":"query","name":"sequence","type":"integer","required":false,"description":"The sequence order of the field in the list of all additional fields"},{"in":"query","name":"filterable","type":"boolean","required":false,"description":"Determine if the field should be present in the catalog filters or not"},{"in":"query","enum":["id_field","sequence"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - sequence"},{"in":"query","enum":["asc","desc"],"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"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"get_total_count","type":"integer","required":false,"description":"If 1 the count of found items will be returned. Options: 0, 1 default 0"}],"summary":"Retrieves the list of all course additional fields, optionally filtered with the input parameters.","last_modified_date":"2026.03.30","description":"All filter parameters are optional.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseIndexFieldResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: association","1002":"Invalid parameter: type"}},"500":{"description":"Internal server error"}}}},"/learn/v1/courses/field/{field_id}":{"delete":{"tags":["Course"],"operationId":"Course./learn/v1/courses/field/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"The ID of the field."}],"summary":"Deletes one course field","last_modified_date":"2026.03.25","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseDeleteFieldResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter: field_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Course"],"operationId":"Course./learn/v1/courses/field/{field_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseUpdateFieldSchema"}},{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Update a course additional field.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseUpdateFieldResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter field_id","1001":"Invalid parameter association","1003":"Invalid parameter show_field","1004":"Invalid parameter name","1005":"Invalid parameter dropdown_options.{x}","1006":"Cannot modify course field with existing entity type.","1007":"Invalid parameter extra_association","1008":"Invalid parameter mandatory","1024":"Invalid parameter settings.filter_logic"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/field/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"The ID of the field."}],"summary":"Get information about a course additional field.","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseViewFieldResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter: field_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/trackings":{"put":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/trackings","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseTrackingsSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"}],"summary":"Synchronizes training material trackings for the specified course and returns an up-to-date snapshot of current user status in the course","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseTrackingsResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Invalid parameter","1003":"Syncing tracking not available for object type {object_type}","1004":"Timestamp {timestamp} should be in format 'yyyy-MM-dd HH:mm:ss'","1006":"Object {lo_id} do not belongs to course {course_id}","1007":"Error while processing the requested operation","1008":"Wrong value {V} for property {X} is provided."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/trackings","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseBatchResetTrackingSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of the course"}],"summary":"Course tracking data reset (lo, tracksession, enrollment completition, dates, score, etc...) for courses with tracking data and, optionally, for courses without tracking data","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseBatchResetTrackingResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing required parameter","1002":"Invalid parameter","1003":"Invalid parameters - normal users can only delete their own trackings"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{id}/download":{"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/download","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"Course ID"}],"summary":"Get downloadable link for course materials","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseDownloadResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{id}/dismission":{"put":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/dismission","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The course ID"}],"summary":"Dismiss a course for logged user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseCreateCourseDismissionResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{id}/dismission","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The course ID"}],"summary":"Undo dismission for a course to logged user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseUndoCourseDismissionResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/classroom/session":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/classroom/session","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseCreateIltsessionSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of course"}],"summary":"Creates a new Classroom session","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseCreateIltsessionResponse"}},"400":{"description":"General Error","error_codes":{"201":"Missing mandatory param 'dates'","205":"Validation errors: ","206":"Save error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/classroom/session","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of course"},{"in":"query","name":"year","type":"string","required":false,"description":"filter the course per year"},{"in":"query","name":"date_from","type":"date","required":false,"description":"filter by session start date from(in format yyyy-MM-dd, UTC timezone)"},{"in":"query","name":"date_to","type":"date","required":false,"description":"filter by session start date to(in format yyyy-MM-dd, UTC timezone)"},{"in":"query","name":"page","type":"integer","required":false,"description":"the page number"},{"in":"query","name":"max_results","type":"integer","required":false,"description":"the number of results per page, default 100, range (1..1000)"}],"summary":"Return the list of scheduled ilt sessions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseListIltsessionResponse"}},"400":{"description":"General Error","error_codes":{"400":"Invalid date_to filter","402":"Invalid id course provided"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/{course_id}/classroom/session/{session_id}":{"put":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/classroom/session/{session_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseUpdateIltsessionSchema"}},{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of course"},{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of session"}],"summary":"Updates an existing session in the LMS","last_modified_date":"2025.10.21","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseUpdateIltsessionResponse"}},"400":{"description":"General Error","error_codes":{"201":"You need to specify at least one date","205":"Validation errors: ","206":"Save error","207":"An error occurred during the update of the session.","208":"An error occurred during the creation of the session's event.","209":"An error occurred during the deletion of the session's old event."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Course"],"operationId":"Course./learn/v1/courses/{course_id}/classroom/session/{session_id}","parameters":[{"in":"path","name":"course_id","type":"integer","required":true,"description":"ID of course"},{"in":"path","name":"session_id","type":"integer","required":true,"description":"ID of the session to delete"}],"summary":"Deletes a session in the LMS","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseDeleteIltsessionResponse"}},"400":{"description":"General Error","error_codes":{"201":"Missing mandatory params","202":"Invalid session ID provided","203":"Invalid course ID provided","204":"Course with id XXX does not have a session with id YYY"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/courses/visibility_check":{"post":{"tags":["Course"],"operationId":"Course./learn/v1/courses/visibility_check","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnCourseVisibilityCheckSchema"}}],"summary":"Check Course Visibility","last_modified_date":"","description":"This API gives information about course visibility in different contexts and based on a specific user","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCourseVisibilityCheckResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/coursedesc/getCourseDescription":{"get":{"tags":["Coursedesc"],"operationId":"Coursedesc./learn/v1/coursedesc/getCourseDescription","parameters":[{"in":"query","name":"course_id","type":"integer","required":true,"description":"The id of the Course"},{"in":"query","name":"current_session_id","type":"id","required":false,"description":"The id of the Course session"},{"in":"query","enum":["learner","admin"],"name":"display_type","type":"string","required":true,"description":"The display type for admin or learner"}],"summary":"Course Description action","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter course_id","1002":"Missing or wrong value for parameter \"display_type\"."}},"500":{"description":"Internal server error"}}}},"/learn/v1/enrollments":{"post":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentCreateSchema"}}],"summary":"Enroll user/s in course/s","last_modified_date":"2025.11.27","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentCreateResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Missing parameter - course_ids.","1003":"Invalid enrollment fields data provided.","1004":"Invalid enrollment level.","1005":"Invalid subscription record.","1006":"No valid users provided to enroll.","1007":"Please provide user_ids and/or branches and/or group_ids","1009":"The count of users exceed limit of remaining availability","1010":"Subscription record expiration date is in the past, can not enroll the user.","1011":"Enrollment active until a date can not be greater than subscription record expiration date, can not enroll the user.","1012":"Invalid parameter: {X}","1013":"Invalid date \"date_begin_validity\".","1014":"Invalid date \"date_expire_validity\".","1015":"'date_expire_validity' cannot be before 'date_begin_validity'.","1016":"Invalid course.","1017":"Normal users cannot enroll as instructors or tutors","1018":"Normal users cannot set validity dates","1019":"User was not successfully enrolled into all courses","1020":"The enrollment attribute {X} is not enabled","1021":"Parameter {X} cannot be set to a future date","1022":"Invalid notification"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentMultipleDeleteSchema"}}],"summary":"Un - Enroll users in course/s","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentMultipleDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1300":"Missing parameter - user_ids.","1301":"Missing required parameters: course_ids or learninplan_ids.","1302":"Nothing to delete.","1303":"Invalid parameter {X}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleSchema"}}],"summary":"Update enrollment of users to courses (Multiple update). NOTE: in order to avoid performance issues or API failures, the API can only handle a maximum of 1000 enrollments per single call.","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide parameter 'user_ids'","1001":"Please provide parameter 'course_ids'","1002":"Invalid enrollment fields data provided.","1003":"No one of provided user(s) is assigned to provided course(s).","1004":"Nothing to update. Please provide at least one valid parameter.","1005":"Model validation error, e.g. [\"95_12301\" => \"Edition ID must be an integer\"] (95 is course ID, 12301 is user ID)","1006":"Invalid parameter: X","1007":"Maximum number of records exceeded","1008":"The enrollment attribute assignment_type is not enabled"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/enrollments/{id_course}/{id_user}":{"delete":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments/{id_course}/{id_user}","parameters":[{"in":"path","name":"id_course","type":"integer","required":true,"description":"The id of the course"},{"in":"path","name":"id_user","type":"integer","required":true,"description":"The id of enrolled user"}],"summary":"Un - Enroll user in course","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1080":"Invalid parameter: id_course","1081":"Invalid parameter: id_user","1083":"This user is not enrolled for this course.","1085":"User is assigned to a learning plan(s) containing this course and cannot be unenrolled"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments/{id_course}/{id_user}","parameters":[{"in":"path","name":"id_course","type":"integer","required":true,"description":"ID of the course"},{"in":"path","name":"id_user","type":"integer","required":true,"description":"ID of the user"}],"summary":"View information for enrolled user on current course.","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentViewResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Records with id_user = {num} and id_course = {num} not exist."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/enrollments/{course_id}/{user_id}":{"put":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments/{course_id}/{user_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleSchema"}},{"in":"path","name":"user_id","type":"integer","required":true,"description":"The ID of enrolled user"},{"in":"path","name":"course_id","type":"integer","required":true,"description":"The ID of course"}],"summary":"Update enrollment of user to course (Single update)","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide valid user_ids","1001":"Please provide valid course_ids","1002":"Invalid enrollment fields data provided.","1003":"No one of provided user(s) is assigned to provided course(s).","1004":"Nothing to update. Please provide at least one valid parameter.","1005":"Model validation error, e.g. [\"95_12301\" => \"Edition ID must be an integer\"] (95 is course ID, 12301 is user ID)","1006":"Invalid parameter {{parameter name}}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments/{course_id}/{user_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentCreateSingleSchema"}},{"in":"path","name":"user_id","type":"integer","required":true,"description":"The ID of user"},{"in":"path","name":"course_id","type":"integer","required":true,"description":"The ID of course"}],"summary":"Enroll a user in a course","last_modified_date":"2025.11.27","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentCreateSingleResponse"}},"400":{"description":"General Error","error_codes":{"1003":"Invalid enrollment fields data provided.","1004":"Invalid enrollment level.","1005":"Invalid subscription record.","1009":"The Licenses subscription is not active or the user is not anymore associated it.","1010":"Session not found"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/enrollment/batch":{"post":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollment/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentBatchImportSchema"}}],"summary":"Batch import Enrollments","last_modified_date":"2025.11.26","description":"Either 'status' fields inside 'items' objects or the 'status' field inside the 'options' object are required.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentBatchImportResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Invalid value for option {X}","1003":"The enrollment attribute {X} is not enabled","1101":"Maximum number of records exceeded","1102":"Please provide valid parameters for an API call","1103":"You do not have enough available seats to perform the requested action. Before using this functionality, please make sure you have purchased enough seats."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollment/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollSchema"}}],"summary":"Batch unenroll of users from courses and sessions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide valid parameters for an API call","1001":"Maximum number of records exceeded","1002":"Invalid value for option"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/enrollments/duplicate":{"put":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments/duplicate","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentDuplicateSchema"}}],"summary":"Duplicate enrollments between courses","last_modified_date":"2025.10.20","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentDuplicateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide from_course","1001":"Please provide to_course","1002":"Invalid to_course","1003":"Invalid from_course","1004":"Cannot duplicate enrollments of courses with different types.","1005":"E-learning courses do not have sessions","1006":"Invalid to_session","1007":"Invalid from_session","1008":"There are no enrolled users in{0} (or the in waiting list of the session)","1009":"There are not enough free seats to complete the enrollment in to_course","1010":"Problem to insert data for enrollment","1011":"Problem inserting data for users sessions","1012":"Problem inserting data for learning progress","1013":"Please provide to_session","1014":"Please provide from_session","1015":"Invalid exclude_course_waiting_list_users"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/enrollment/{id_course}/{id_user}/session/{id_session}":{"delete":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollment/{id_course}/{id_user}/session/{id_session}","parameters":[{"in":"path","name":"id_course","type":"integer","required":true,"description":"The id of the course"},{"in":"path","name":"id_user","type":"integer","required":true,"description":"The id of the user"},{"in":"path","name":"id_session","type":"integer","required":true,"description":"The id of session"}],"summary":"Un - Enroll user in ILT","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentDeleteSessionResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter - id_course","1002":"User is not subscribed to this session"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/enrollment/pending_users":{"get":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollment/pending_users","parameters":[{"in":"query","name":"user_id","type":"integer","required":false,"description":"User internal ID of the admin, who can manage pending enrollments"},{"in":"query","enum":["username","course_name","subscription_date"],"name":"sort_attr","type":"string","required":false,"description":"Sort data by requested field. Default is subscription_date"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search phrase for course_name or username fields"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, 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. Default to the platform setting for pagination"},{"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":"If 1, generate and return 'cursor' and prebuilt navigational '_links'. Default=0"}],"summary":"Get pending enrollments, for users that are waiting for Admin Approval","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentPendingUsersResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/enrollment/importer_fields":{"get":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollment/importer_fields","parameters":[{"in":"query","name":"course_id","type":"integer","required":false,"description":"ID of a course, if it was provided and the course is E-Learning, don't return in response a course id, course code, session id and session code. "},{"in":"query","name":"session_id","type":"integer","required":false,"description":"ID of a session, if it was provided don't return in response a session id and session code. "},{"in":"query","name":"is_unenroll","type":"boolean","required":false,"description":"If it is set to 'true' the response will not include 'level', 'active_from', 'active_until' and additional fields. Default: 'false'"}],"summary":"Returns list of mappable fields for the data importer","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentImporterFieldsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid entity type","1002":"The course doesn't exist","1003":"Do not have the needed permissions"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/enrollments/sessions/batch":{"delete":{"tags":["Enrollment"],"operationId":"Enrollment./learn/v1/enrollments/sessions/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollSessionSchema"}}],"summary":"Batch delete enrollments to a session","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollSessionResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/external_training":{"post":{"tags":["ExternalTraining"],"operationId":"ExternalTraining./learn/v1/external_training","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnExternaltrainingCreateSchema"}}],"summary":"Create external training","last_modified_date":"2025.09.25","description":"The endpoint will create the course and the institute if they're missing in the defined list.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnExternaltrainingCreateResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["ExternalTraining"],"operationId":"ExternalTraining./learn/v1/external_training","parameters":[{"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"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in user_id, uuid, username, training_institute_code, training_institute and course_code of the external training"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"},{"in":"query","name":"get_total_count","type":"integer","required":false,"description":"If 1 the count of found items will be calculated, else the count return=0. Options: 0, 1 default 0"}],"summary":"Returns list of External training","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnExternaltrainingIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/external_training/{id}":{"delete":{"tags":["ExternalTraining"],"operationId":"ExternalTraining./learn/v1/external_training/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the external training (transcripts_record)"}],"summary":"Delete an External training","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnExternaltrainingDeleteResponse"}},"400":{"description":"General Error","error_codes":{"4000":"You must provide external training ID ","4001":"Invalid external training ID","4002":"The on external training deletion is unsuccessful","4003":"Could not delete external training"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["ExternalTraining"],"operationId":"ExternalTraining./learn/v1/external_training/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnExternaltrainingUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the training record"}],"summary":"Update external training","last_modified_date":"2024.02.19","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnExternaltrainingUpdateResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["ExternalTraining"],"operationId":"ExternalTraining./learn/v1/external_training/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the external training (transcripts_record)"}],"summary":"View an External training","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnExternaltrainingViewResponse"}},"400":{"description":"General Error","error_codes":{"4000":"You must provide external training ID","4001":"Invalid external training ID","4002":"Could not view the external training"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/external_training/batch_import":{"post":{"tags":["ExternalTraining"],"operationId":"ExternalTraining./learn/v1/external_training/batch_import","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnExternaltrainingBatchImportSchema"}}],"summary":"Import external training","last_modified_date":"","description":"This API will be deprecated soon, please use the new endpoint /learn/v1/external_training/batch.
The endpoint will create the course and the institute if they're missing in the defined list.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnExternaltrainingBatchImportResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/external_training/batch":{"post":{"tags":["ExternalTraining"],"operationId":"ExternalTraining./learn/v1/external_training/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnExternaltrainingBatchSchema"}}],"summary":"Import external training","last_modified_date":"2022.11.04","description":"Notes about the dates: please always provide both from_date and to_date. If you want to specify the completion date for an E-Learning course, just put the same date for both fields.
The endpoint will create the course and the institute if they're missing in the defined list.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnExternaltrainingBatchResponse"}},"400":{"description":"General Error","error_codes":{"5000":"Invalid additional_fields format","5001":"Invalid field ID ","5002":"Invalid option ID for field ID ","5003":"Invalid date format ","6000":"DB validation errors"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/forum/getForumData":{"get":{"tags":["Forum"],"operationId":"Forum./learn/v1/forum/getForumData","parameters":[{"in":"query","name":"course_id","type":"integer","required":true,"description":"the id of the course"}],"summary":"Forum Data action","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnForumGetForumDataResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter course_id","1002":"Invalid parameter: course_id","1003":"Cannot find course with id: {X}."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/ilt/get_multiple_ilt_sessions":{"get":{"tags":["Ilt"],"operationId":"Ilt./learn/v1/ilt/get_multiple_ilt_sessions","parameters":[{"in":"query","name":"search_text","type":"string","required":false,"description":"Partial match search in the following fields: username, firstname, lastname, evaluation_comment"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"session_ids","type":"array","required":false,"description":"Filter by ids of the sessions"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"user_ids","type":"array","required":false,"description":"Filter by ids of the users"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"levels","type":"array","required":false,"description":"Filter by enrollment levels of the users. Possible values (learner, instructor, tutor)"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"statuses","type":"array","required":false,"description":"Filter by session enrollment statuses. Possible values (subscribed, in_progress, completed, subscription_to_confirm, waiting, suspended)"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"course_ids","type":"array","required":false,"description":"Filter by ids of the course"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"course_statuses","type":"array","required":false,"description":"Filter by course enrollment statuses. Possible values(subscribed, in_progress, completed, subscription_to_confirm, waiting, suspended, overbooking)"},{"in":"query","enum":["session_id","user_id","username","firstname","lastname","level","status","enrollment_date","completion_date","course_id","course_status","course_final_score","course_enrollment_date","course_completion_date","attendance","evaluation_status","evaluation_score","evaluation_comment","evaluation_date","evaluator_id"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by either not passing get_cursor or passing it with value 1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=1"}],"summary":"Get full session info for multiple sessions in different courses","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter search_text","1002":"Invalid parameter session_ids","1003":"Invalid parameter user_ids","1004":"Invalid parameter levels","1005":"Invalid parameter statuses","1006":"Invalid parameter course_ids","1007":"Invalid parameter course_statuses"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/instructor/getInstructorData":{"get":{"tags":["Instructor"],"operationId":"Instructor./learn/v1/instructor/getInstructorData","parameters":[{"in":"query","name":"user_id","type":"integer","required":true,"description":"The id of the user"},{"in":"query","name":"course_id","type":"integer","required":true,"description":"The id of the course"},{"in":"query","name":"session_id","type":"integer","required":false,"description":"The id of the course session"}],"summary":"Get all instructors assigned to a specific course","last_modified_date":"2022.10.18","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnInstructorGetInstructorDataResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: user_id","1002":"Invalid parameter: course_id","1003":"Invalid parameter: session_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/instructor/assignments":{"get":{"tags":["Instructor"],"operationId":"Instructor./learn/v1/instructor/assignments","parameters":[{"in":"query","name":"id_user","type":"integer","required":false,"description":"ID of the LMS user"},{"in":"query","enum":["learner","instructor"],"name":"level","type":"string","required":false,"description":"Level of the provided user. In case "learner": API will return all submitted assignments of the student, in case of "instructor": all unevaluated assignments where provided user is instructor."},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search phrase for name column"},{"in":"query","enum":["code","name","type","is_public"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, 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. Default to the platform setting for pagination"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"}],"summary":"Get assignments for student or assignments to be evaluated from provided instructor","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnInstructorAssignmentsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/{id}":{"get":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The learning object ID"}],"summary":"Returns information for a single learning object","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoViewResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/{id_lo}/play":{"get":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/{id_lo}/play","parameters":[{"in":"path","name":"id_lo","type":"string","required":true,"description":"ID if the LO or combination if ID LO and SCO/TIN CAN item (id_lo:id_chapter). If no chapter is present for scorms the launch_params in the response will be empty array"},{"in":"query","name":"device","type":"string","required":false,"description":"Device the API client is going to use. Allowed values: 'tablet', 'desktop', 'smartphone' or 'mobile'"},{"in":"query","name":"learning_plan_id","type":"integer","required":false,"description":"Learning plan ID"},{"in":"query","enum":["lms","golearn","flow","flow_msteams"],"name":"context","type":"string","required":false,"description":"The context in which the learning object is being played. Default is 'lms'."}],"summary":"Play single LO or scorm|tincan chapter","last_modified_date":"2025.05.20","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoPlayResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1080":"Invalid parameter \"id\"","1003":"Something went wrong","1004":"LO is locked","1005":"First name or last name missing","1006":"Wrong value for parameter 'context'"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/{id}/track":{"post":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/{id}/track","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLoTrackSchema"}},{"in":"path","name":"id","type":"string","required":true,"description":"The ID of the learning object or SCO chapter"}],"summary":"Track single LO","last_modified_date":"","description":"More detailed information:
https://help.docebo.com/hc/en-us/articles/11489147129234","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoTrackResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: \"id\".","1002":"Invalid parameter: \"track\".","1003":"Resource not found.","1004":"Something went wrong.","1005":"Missing parameter.","1006":"You cannot re-submit assignments that are competed or are not evaluated yet.","1007":"Invalid track action.","1008":"Cannot begin the test. Maximum attempts exceeded.","1009":"Cannot continue the Test.","1010":"You are suspended until {time}","1011":"Missing initial status, please start the test first.","1012":"Invalid user status.","1013":"No next page found.","1014":"Invalid input data","1015":"You are required to answer all questions.","1016":"No previous page found.","1017":"You have no permission to go to previous page","1018":"Test submission not allowed at current stage.","1019":"Cannot override previous answers.","1020":"Timing not enabled for this Test.","1021":"Test was not recently started.","1022":"Test was recently started.","1023":"Incorrect timing setting.","1024":"Time is up for the given test","1025":"The time for this Test is still not over","1026":"Wrong value for parameter context","1030":"Missing parameter: link","1031":"Invalid parameter: link","9010":"Proctoring required user information is missing","9011":"Proctoring status not allowing test interactions"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/batch\r":{"post":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/batch\r","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLoBatchSchema"}}],"summary":"Batch import of Learning Objects\r","last_modified_date":"2022.08.19\r","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoBatchResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameters items\r","1001":"Maximum number of records exceeded\r","1002":"Invalid value for option\r","1003":"Invalid parameter: options.s3_region\r"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/tracks/batch":{"post":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/tracks/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingSchema"}}],"summary":"Batch insert of Tracking for Learning Objects","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameters items","1001":"Maximum number of records exceeded","1002":"Invalid value for option"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/tracks/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLoBatchResetTrackingSchema"}}],"summary":"Batch reset of LO tracking data","last_modified_date":"","description":"This endpoint is deprecated and it will be dismissed soon. We strongly recommend that you refactor your code to use the new \"DELETE /learn/v1/courses/{course_id}/trackings\"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoBatchResetTrackingResponse"}},"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"}}}},"/learn/v1/lo/tests/batch":{"post":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/tests/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLoTestsBatchSchema"}}],"summary":"Batch insert of test/quiz questions","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoTestsBatchResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameters items","1001":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/{id}/download":{"get":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/{id}/download","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"Learning Object ID"}],"summary":"Get downloadable link for training materials","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoDownloadResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/screenrecording":{"post":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/screenrecording","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLoUpdateScreenrecordingSchema"}}],"summary":"Creates LO of type Screen-recording","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoUpdateScreenrecordingResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Filename parameter is required"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/screenrecording/presigned_url":{"post":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/screenrecording/presigned_url","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLoCreateScreenrecordingPresignedUrlSchema"}}],"summary":"Generate Pre Signed URL for Screencast asset","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoCreateScreenrecordingPresignedUrlResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter: filename","1002":"Invalid parameter: filename"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/scorminteraction/{scorm_id}/list":{"get":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/scorminteraction/{scorm_id}/list","parameters":[{"in":"path","name":"scorm_id","type":"integer","required":true,"description":"The id of the SCO item where the test/quiz is located"},{"in":"query","name":"user_id","type":"integer","required":false,"description":"The id of the user whose interactions will be retrieved. If not provided the retrieved list will be for the current user"}],"summary":"Returns the list of SCORM interactions for a certain user in a SCO object","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoScormInteractionResponse"}},"400":{"description":"General Error","error_codes":{"201":"Missing required input parameters","202":"Invalid id_user","203":"Invalid id_scormitem","254":"No SCORM tracking data available for the specified user"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/importer_fields":{"get":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/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/LearnLoImporterFieldsResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lo/{id}/assignment-evaluation/batch":{"post":{"tags":["Lo"],"operationId":"Lo./learn/v1/lo/{id}/assignment-evaluation/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLoBatchAssignmentEvaluationSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the learning object that the evaluation refers to"}],"summary":"Batch evaluate a list of assignments","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLoBatchAssignmentEvaluationResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: \"id\".","1002":"Invalid parameter: \"submission_id\".","1003":"Invalid parameter: \"items\".","1004":"Something went wrong.","1006":"Missing parameter","1007":"Invalid parameter: \"score\".","1008":"Invalid parameter: \"instructor_id\".","1009":"Invalid parameter: \"status\".","1010":"Assignment already evaluated.","1011":"User not enrolled.","1026":"Maximum number of evaluations exceeded","1028":"Invalid user id","1029":"User is not assigned to the Power user","1030":"Course is not assigned to the Power user","1031":"Power user doesn't meet required permissions","1032":"User passed as instructor is neither an Instructor or a Tutor of this course","1033":"User passed as instructor is not enrolled in the course"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/location":{"get":{"tags":["Location"],"operationId":"Location./learn/v1/location","parameters":[{"in":"query","enum":["id","name"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id."},{"in":"query","enum":["asc","desc"],"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 10"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"}],"summary":"Returns list of Locations","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLocationIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"post":{"tags":["Location"],"operationId":"Location./learn/v1/location","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLocationCreateSchema"}}],"summary":"Creates a new ILT location with the given details","last_modified_date":"2023.06.29","description":"You can refer to the Country list in ILT locations management for the complete list of country names.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLocationCreateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter 'X'","1002":"Invalid parameter: X","1003":"Invalid country"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/location/{location_id}":{"get":{"tags":["Location"],"operationId":"Location./learn/v1/location/{location_id}","parameters":[{"in":"path","name":"location_id","type":"integer","required":true,"description":"The ID of the location"}],"summary":"Retrieving information about certain location","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLocationLocationResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid location id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Location"],"operationId":"Location./learn/v1/location/{location_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLocationUpdateSchema"}},{"in":"path","name":"location_id","type":"string","required":true,"description":"ID of the location"}],"summary":"Update an existing ILT location with the given details","last_modified_date":"","description":"You can refer to the Country list in ILT locations management for the complete list of country names.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLocationUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing or empty location name","1002":"Missing or empty country name","1003":"Invalid country","1004":"Missing or empty id_location param","1005":"Invalid location id","1006":"Cannot save the location"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Location"],"operationId":"Location./learn/v1/location/{location_id}","parameters":[{"in":"path","name":"location_id","type":"integer","required":true,"description":"ID of the location"}],"summary":"Delete an existing ILT location with the given location id","last_modified_date":"","description":"You can refer to the Country list in ILT locations management for the complete list of country names.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLocationDeleteResponse"}},"400":{"description":"General Error","error_codes":{"4000":"Missing required location id","1002":"Failed to find the location model","1003":"Failed to delete LtLocation instance"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/location/{location_id}/classroom/{classroom_id}":{"get":{"tags":["Location"],"operationId":"Location./learn/v1/location/{location_id}/classroom/{classroom_id}","parameters":[{"in":"path","name":"location_id","type":"integer","required":true,"description":"The ID of the location"},{"in":"path","name":"classroom_id","type":"integer","required":true,"description":"The ID of the classroom"}],"summary":"Retrieving information about certain location classroom","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLocationLocationClassroomResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid location id","1002":"Invalid classroom id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/location/{location_id}/classroom":{"get":{"tags":["Location"],"operationId":"Location./learn/v1/location/{location_id}/classroom","parameters":[{"in":"path","name":"location_id","type":"integer","required":true,"description":"The ID of the location"},{"in":"query","enum":["name","id","seats"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id"},{"in":"query","enum":["asc","desc"],"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 10"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"}],"summary":"Retrieving all classrooms from a specified location id","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLocationLocationClassroomIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid location id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lp":{"post":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLpCreateSchema"}}],"summary":"Create a new Learning plan","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpCreateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Learning plan creation fails"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp","parameters":[{"in":"query","name":"id_user","type":"integer","required":false,"description":"Id of specific LMS user to return Learning plans, that he is enrolled in"},{"in":"query","name":"updated_from","type":"datetime","required":false,"description":"Sets the beginning of the range of time reported by the query. The updated_from must be before the updated_to (if specified) and the current time when the request is made, or the API returns an error. Accepted format is "yyyy-MM-dd HH:mm:ss", UTC timezone. Default value is null"},{"in":"query","name":"updated_to","type":"datetime","required":false,"description":"Sets the end of the range of time reported by the query. If the updated_to is not specified, the report returns all activities from the updated_from until the current time. Accepted format is "yyyy-MM-dd HH:mm:ss", UTC timezone. Default value is current_timestamp"},{"in":"query","name":"return_courses","type":"boolean","required":false,"description":"if set to true return also the details of the courses in this Learning Plan"},{"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 20"},{"in":"query","enum":["id","name","last_update"],"name":"sort_attr","type":"string","required":false,"description":"Sorting the result by column name (default id)"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction - can be 'asc' or 'desc', if not provided of is different, the sort_by parameter will be ignored!"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"},{"in":"query","name":"search_text","type":"string","required":false,"description":"A fulltext search to filter the results for. Will search in the lp name or code fields"}],"summary":"Returns list of Learning Plans","last_modified_date":"2026.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid user id","1002":"Invalid parameter"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lp/{id}":{"delete":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp/{id}","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"ID of the Learning plan"}],"summary":"Delete specific Learning plan by given ID","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter","1002":"Invalid learning plan","1003":"Error when deleting learning plan"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLpUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"ID ot the Learning plan"}],"summary":"Update specific Learning plan","last_modified_date":"2025.06.10","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing parameter {0}","1002":"Learning plan not found","1003":"Errors while updating the Learning plan"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lp/{lp_id}":{"get":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp/{lp_id}","parameters":[{"in":"path","name":"lp_id","type":"integer","required":true,"description":"ID of the learning plan"},{"in":"query","enum":["published","under_maintenance"],"name":"course_status","type":"string","required":false,"description":"Filters courses that belong to the Learning Plan by their status."}],"summary":"View a Learning plan","last_modified_date":"2026.01.26","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpViewResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Error while processing the requested operation","1002":"Invalid parameter: course_status","9000":"Something went wrong with JWT"}},"500":{"description":"Internal server error"}}}},"/learn/v1/lp/enroll":{"post":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp/enroll","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLpEnrollSchema"}}],"summary":"Enroll single user in Learning plan","last_modified_date":"2026.04.23","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpEnrollResponse"}},"400":{"description":"General Error","error_codes":{"422":"This operation is not allowed on Certification enrollments","1001":"Missing parameter '{X}'","1002":"Learning plan not found (Super Admin only)","1003":"User not found (Super Admin only)","1004":"User already enrolled","1005":"Errors while enrolling","1006":"Errors while enrolling in courses.","1007":"Invalid parameter: {X}","1008":"Missing authorization"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lp/{id_plan}/deeplink":{"post":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp/{id_plan}/deeplink","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLpDeeplinkSchema"}},{"in":"path","name":"id_plan","type":"integer","required":true,"description":"ID of the Learging plan"}],"summary":"Deeplinking is enabled in the advanced settings of a LP and it allows to share a LP with anybody using a signed link","last_modified_date":"2024.10.24","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpDeeplinkResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lp/{id}/dismission":{"put":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp/{id}/dismission","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The learning plan ID"}],"summary":"Dismiss a learning plan for logged user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpCreateLpDismissionResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp/{id}/dismission","parameters":[{"in":"path","name":"id","type":"integer","required":true,"description":"The learning plan ID"}],"summary":"Undo dismission for a learning plan to logged user","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpUndoLpDismissionResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/lp/{learningplan_id}/enroll/{user_id}":{"delete":{"tags":["Lp"],"operationId":"Lp./learn/v1/lp/{learningplan_id}/enroll/{user_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnLpUnenrollSchema"}},{"in":"path","name":"learningplan_id","type":"string","required":true,"description":"ID of the learning plan to unenroll, or code of the learning plan to unenroll"},{"in":"path","name":"user_id","type":"integer","required":true,"description":"Docebo ID of the user to unenroll"}],"summary":"Unenrolls a user from a learning plan","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnLpUnenrollResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Missing mandatory params","1002":"Invalid Learning Plan ID/code provided or Invalid User ID provided","1003":"User is not enrolled in this Learning Plan","2000":"Invalid parameter learningplan_id"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle":{"post":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionbundleCreateSchema"}}],"summary":"Creates a new subscription bundle","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleCreateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: {X}","1015":"Invalid additional_fields","1081":"Parameter published must be 0 or 1","1082":"Invalid parameter - branches.","1083":"Missing parameter - name.","1084":"Missing parameter - description.","1085":"Please provide type","1086":"Please provide valid type - 1 or 2","1087":"Invalid parameter - items.","1088":"Model errors","1089":"Invalid parameter - propagate_to_transactions.","7000":"Some mandatory additional fields are not provided","7001":"Invalid additional fields data","7002":"DB problem to save Additional fields"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle","parameters":[{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"subscription_title","type":"array","required":false,"description":"Search text in the subscription bundle title. Default empty array. OR is performed across array items"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"subscription_description","type":"array","required":false,"description":"Search text in the subscription bundle description. Default empty array. OR is performed across array items"},{"in":"query","name":"code","type":"string","required":false,"description":"Filter returned bundles by code"},{"in":"query","enum":["id","name","code"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"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"},{"in":"query","name":"published","type":"integer","required":false,"description":"Filter by published field. Options: 1 - published, 0 - not published. Default - all. Filter available only for SA and PU. Normal user and guest can see only published bundles"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"}],"summary":"Retrieves all subscription bundles, filtered on input parameters","last_modified_date":"","description":"All filter parameters are optional. If both subscription_title and subscription_description are searched, then an OR operation is performed. If other filter parameters are provided, then an \"AND\" is performed across the other parameters.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleIndexResponse"}},"400":{"description":"General Error","error_codes":{"403":"Forbidden"}},"500":{"description":"Internal server error"}}}},"/learn/v1/sub_bundle/{bundle_id}":{"delete":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}","parameters":[{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"ID of subscription bundle to fetch"}],"summary":"Deletes one subscription bundle","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1080":"Invalid parameter - bundle_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateSchema"}},{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"Subscription bundle id"}],"summary":"Update a subscription bundle","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter: {X}","1079":"Invalid parameter - branches.","1080":"Invalid parameter - bundle_id.","1081":"Please provide valid type - 1 or 2","1082":"Please provide valid published value - 0 or 1","1083":"Model errors","1084":"Invalid parameter - propagate_to_transactions."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}","parameters":[{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"Subscription bundle id"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"}],"summary":"View a subscription bundle","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleViewResponse"}},"400":{"description":"General Error","error_codes":{"1080":"Invalid parameter - bundle_id."}},"500":{"description":"Internal server error"}}}},"/learn/v1/sub_bundle/{bundle_id}/items":{"post":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/items","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionbundleCreateItemsSchema"}},{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"Subscription bundle ID"}],"summary":"Creates new subscription bundle items","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleCreateItemsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"- Unexpected error","1001":"- An error occurred","1003":"- Invalid request: all required parameters are null","1004":"- Invalid parameters combination: items and select_all can't be in the same request","1005":"- Invalid parameters combination: items and select_all_search_filter can't be in the same request","1006":"- Invalid parameter value type: select_all should be a boolean","1007":"- Invalid parameter value: select_all should be true","1008":"- Invalid parameter value type: select_all_text_filter should be a string","1009":"- Invalid parameter value type: items should be an array","1010":"- Invalid parameter value type: items should be an array of integers"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/items","parameters":[{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"Subscription bundle id"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search phrase for name column"},{"in":"query","enum":["id","name"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - name."},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, 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. Default to the platform setting for pagination"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"}],"summary":"Get the subscription bundle items","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleItemsResponse"}},"400":{"description":"General Error","error_codes":{"1080":"Invalid parameter - bundle_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle/{bundle_id}/item/{item_id}":{"delete":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/item/{item_id}","parameters":[{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"ID of subscription bundle to fetch"},{"in":"path","name":"item_id","type":"integer","required":true,"description":"ID of subscription bundle item to fetch"}],"summary":"Deletes subscription bundle item","last_modified_date":"2023.04.24","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemResponse"}},"400":{"description":"General Error","error_codes":{"1080":"Invalid parameter - bundle_id.","1081":"Invalid parameter - item_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle/{bundle_id}/item":{"delete":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/item","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsSchema"}},{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"ID of subscription bundle to fetch"}],"summary":"Deletes subscription bundle items","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsResponse"}},"400":{"description":"General Error","error_codes":{"1079":"Missing parameter - item_ids.","1080":"Invalid parameter - bundle_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle/{bundle_id}/visibility":{"post":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/visibility","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityL2Schema"}},{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"Subscription bundle ID"}],"summary":"Update a subscription bundle visibility","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityL2Response"}},"400":{"description":"General Error","error_codes":{"1080":"Invalid parameter - bundle_id.","1081":"Please provide branch_ids or/and group_ids","1082":"Invalid parameter - branch_ids.","1083":"Parameter selection_status must be 1 or 2.","1084":"Invalid parameter group_ids"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle/{bundle_id}/visibility/{visibility_id}":{"delete":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/visibility/{visibility_id}","parameters":[{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"Subscription bundle ID"},{"in":"path","name":"visibility_id","type":"integer","required":true,"description":"Subscription bundle visibility ID"}],"summary":"Delete a subscription bundle visibility","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteVisibilityResponse"}},"400":{"description":"General Error","error_codes":{"1080":"Invalid parameter - bundle_id.","1081":"Invalid parameter - visibility_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle/{bundle_id}/courses":{"get":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/courses","parameters":[{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"ID of the Subscription bundle"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"type","type":"array","required":false,"description":"Filtering by Type ("classroom", "elearning", "mobile", "learning_plan")"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"lang_code","type":"array","required":false,"description":"Filtering by Language ("en", "bg", etc.)"},{"in":"query","name":"duration_start","type":"integer","required":false,"description":"Search course with duration equal to or more than given value (n/a for learning plans)"},{"in":"query","name":"duration_end","type":"integer","required":false,"description":"Search course with duration equal to or less than given value (n/a for learning plans)"},{"in":"query","collectionFormat":"brackets","items":{"type":"integer"},"name":"catalog_ids","type":"array","required":false,"description":"Filter by given Catalog IDs"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Search text in the course/plan name."},{"in":"query","enum":["item_id","item_name"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - item_name"},{"in":"query","enum":["asc","desc"],"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"}],"summary":"Get all courses and learning plans for given Subscription bundle","last_modified_date":"2025.05.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleGetCoursesLpsResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide valid type","1002":"Type must be an array","1003":"Invalid type - \"bla\"(user provided value)","1008":"lang_code must be an array","1009":"lang_code \"bla\"(user provided value) is invalid","1010":"Your request was made with invalid credentials","1011":"Subscription with ID: {id} not found!","1012":"Field enrollment_fields not valid"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/learn/v1/sub_bundle/{bundle_id}/filters":{"get":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/filters","parameters":[{"in":"path","name":"bundle_id","type":"integer","required":false,"description":"Id of the given bundle."}],"summary":"Retrieves all filter options by subscription ID","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleGetFiltersResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Something went wrong!","1001":"Bundle not found"}},"500":{"description":"Internal server error"}}}},"/learn/v1/sub_bundle/batch":{"post":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionbundleBatchSchema"}}],"summary":"Batch import for subscription bundles from CSV","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleBatchResponse"}},"400":{"description":"General Error","error_codes":{"1015":"Invalid additional_fields","1102":"No items to be imported","1103":"Maximum number of records exceeded","7000":"Some mandatory additional fields are not provided","7001":"Invalid additional fields data","7002":"DB problem to save Additional fields"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle/items/batch":{"post":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/items/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchSchema"}}],"summary":"Batch import for subscription bundles from CSV","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchResponse"}},"400":{"description":"General Error","error_codes":{"1102":"No items to be imported","1103":"Import limit exceeded. Max {number_of_records} records allowed per batch."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle/visibility/batch":{"post":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/visibility/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchSchema"}}],"summary":"Batch import for subscription bundles visibility","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchResponse"}},"400":{"description":"General Error","error_codes":{"1102":"No items to be imported","1103":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_bundle/{bundle_id}/assignable/items":{"get":{"tags":["SubscriptionBundle"],"operationId":"SubscriptionBundle./learn/v1/sub_bundle/{bundle_id}/assignable/items","parameters":[{"in":"path","name":"bundle_id","type":"integer","required":true,"description":"Subscription bundle id"},{"in":"query","name":"cursor","type":"string","description":"Data set navigational cursor previously obtained by passing get_cursor=1. This parameter is to be considered as deprecated and it will be removed in a future release.","default":""},{"in":"query","name":"get_cursor","type":"integer","description":"Generate and return \"cursor\" and prebuilt navigational \"_links\". Default=0. This parameter is to be considered as deprecated and it will be removed in a future release.","default":""},{"in":"query","name":"page_size","type":"integer","description":"Maximum number of results per page. Maximum value 200","default":"20"},{"in":"query","name":"page","type":"integer","description":"Page to return, default 1.","default":"1"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Filter result by name/description/code"},{"in":"query","enum":["id","name","description","code"],"name":"sort_attr","type":"string","required":false,"description":"The name of the sortable field. Sorted by: id, name, description, code. Default: name"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting direction: asc = ascending, desc = descending. Default: asc"}],"summary":"Get the assignable items for a subscription bundle","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter: bundle_id","1001":"Unexpected error","1002":"An error occurred"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_field":{"post":{"tags":["SubscriptionField"],"operationId":"SubscriptionField./learn/v1/sub_field","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionfieldCreateSchema"}}],"summary":"Create subscription field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionfieldCreateResponse"}},"400":{"description":"General Error","error_codes":{"1101":"Missing parameter - type.","1102":"Invalid parameter - type.","11011":"Missing parameter - subscription type.","11021":"Invalid parameter - subscription type.","1103":"Missing parameter - translations.","1104":"Please provide translation on system default language.","1105":"Missing parameter - dropdown_options.","1106":"Invalid parameter - dropdown_options."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionField"],"operationId":"SubscriptionField./learn/v1/sub_field","parameters":[{"in":"query","name":"only_mandatory","type":"array","required":false,"description":"Filter subscription additional fields by mandatory option."},{"in":"query","name":"subscription_type","type":"integer","required":false,"description":"Filter subscription additional fields by type of subscription 1 - 'plan', 2 - 'bundle' or 3 - 'record'"},{"in":"query","name":"as_array","type":"integer","required":false,"description":"If it is not passed the response will be simplified paginated list. If it is passed the response will contains fully filled list (drop down with options, etc.)"},{"in":"query","name":"id_object","type":"integer","required":false,"description":"Filter subscription additional fields by object (plan or bundle) ID."},{"in":"query","name":"id_plan","type":"integer","required":false,"description":"Filter subscription additional fields by plan ID."},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"search_text","type":"array","required":false,"description":"Search text in the user field title. Default empty array. OR is performed among multiple array items"},{"in":"query","enum":["id","title","position"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - position"},{"in":"query","enum":["asc","desc"],"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"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"in":"query","name":"multidomain","type":"integer","required":false,"description":"If 1 and no folder was send it will check also for the multidomain specific folder assigned fields. Options: 0, 1 default 0"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"}],"summary":"Returns list of Subscription fields","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionfieldIndexResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter.","1002":"No additional fields found."}},"500":{"description":"Internal server error"}}},"delete":{"tags":["SubscriptionField"],"operationId":"SubscriptionField./learn/v1/sub_field","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteMultipleSchema"}}],"summary":"Deletes Subscription fields","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteMultipleResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter 'field_ids'"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_field/{field_id}":{"delete":{"tags":["SubscriptionField"],"operationId":"SubscriptionField./learn/v1/sub_field/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Deletes a Subscription field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid operation. Field ID can not be deleted"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionField"],"operationId":"SubscriptionField./learn/v1/sub_field/{field_id}","parameters":[{"in":"path","name":"field_id","type":"integer","required":true,"description":"ID of selected field."}],"summary":"Get Subscription Field data","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionfieldViewResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_field/{id}":{"put":{"tags":["SubscriptionField"],"operationId":"SubscriptionField./learn/v1/sub_field/{id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateSchema"}},{"in":"path","name":"id","type":"integer","required":true,"description":"Id of selected field."}],"summary":"Update subscription field","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1002":"Additional field with id: idNum dosn\\'t exist.","1003":"Please provide field name"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_plan":{"post":{"tags":["SubscriptionPlan"],"operationId":"SubscriptionPlan./learn/v1/sub_plan","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionplanCreateSchema"}}],"summary":"Creates a new Subscription plan","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionplanCreateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide bundle_id","1001":"Please provide valid bundle_id","1002":"Please provide type","1003":"Please provide valid type - 1 or 2","1004":"Please provide price","1005":"Please provide availability","1006":"Please provide renewal_type","1007":"Please provide valid renewal_type - 1, 2 or 3","1008":"Please provide validity_units","1009":"Please provide valid validity_units - 1, 2 or 3","1010":"Please provide validity_period","1011":"Please provide enforce_limit","1012":"Please provide valid enforce_limit - 0 or 1","1013":"Model validation errors - example: \"Availability must be an integer.\"","1014":"You are not allowed to assign this bundle_id","1015":"Invalid additional_fields","1016":"Please provide name","7000":"Some mandatory additional fields are not provided","7001":"Invalid additional fields data","7002":"DB problem to save Additional fields","9000":"Subscription app is not activated"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionPlan"],"operationId":"SubscriptionPlan./learn/v1/sub_plan","parameters":[{"in":"query","name":"bundle_id","type":"integer","required":false,"description":"Filter returned plans by subscription bundle"},{"in":"query","name":"code","type":"string","required":false,"description":"Filter returned plans by code"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"subscription_title","type":"array","required":false,"description":"Search text in the subscription plan title. Default empty array. OR is performed across array items"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"subscription_description","type":"array","required":false,"description":"Search text in the subscription bundle description. Default empty array. OR is performed across array items"},{"in":"query","enum":["id","plan_name","code","plan_price","renewal_type","availability"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, default - desc"},{"in":"query","name":"lang","type":"string","required":false,"description":"Language code. Language used to process input parameters, sort data, and provide the output. Default - Platform default language"},{"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"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"}],"summary":"Retrieves all subscription plans, filtered on input parameters","last_modified_date":"","description":"All filter parameters are optional. If both subscription_title and subscription_description are searched, then an OR operation is performed. If other filter parameters are provided, then an \"AND\" is performed across the other parameters.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionplanIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_plan/purchase":{"post":{"tags":["SubscriptionPlan"],"operationId":"SubscriptionPlan./learn/v1/sub_plan/purchase","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionplanPurchaseSchema"}}],"summary":"Purchasing subscription plan","last_modified_date":"2025.03.12","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionplanPurchaseResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_plan/{plan_id}":{"delete":{"tags":["SubscriptionPlan"],"operationId":"SubscriptionPlan./learn/v1/sub_plan/{plan_id}","parameters":[{"in":"path","name":"plan_id","type":"integer","required":true,"description":"ID of subscription plan to fetch"}],"summary":"Deletes one subscription plan","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionplanDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - plan_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["SubscriptionPlan"],"operationId":"SubscriptionPlan./learn/v1/sub_plan/{plan_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionplanUpdateSchema"}},{"in":"path","name":"plan_id","type":"integer","required":true,"description":"ID of subscription plan to update"}],"summary":"Update a Subscription plan","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionplanUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - plan_id.","1003":"Please provide valid renewal_type - 1, 2 or 3","1004":"Please provide valid validity_units - 1, 2 or 3","1005":"Please provide valid enforce_limit - 0 or 1","1007":"Model validation errors - examples: \"Availability must be an integer.\", \"Code must be a string.\"","9000":"Subscription app is not activated"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionPlan"],"operationId":"SubscriptionPlan./learn/v1/sub_plan/{plan_id}","parameters":[{"in":"path","name":"plan_id","type":"integer","required":true,"description":"ID of subscription plan to fetch"}],"summary":"View a Subscription plan","last_modified_date":"2024.11.12","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionplanViewResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - plan_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_plan/batch":{"post":{"tags":["SubscriptionPlan"],"operationId":"SubscriptionPlan./learn/v1/sub_plan/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionplanBatchSchema"}}],"summary":"Batch import for subscription plans","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionplanBatchResponse"}},"400":{"description":"General Error","error_codes":{"1015":"Invalid additional_fields","1102":"No items to be imported","1103":"Maximum number of records exceeded","7000":"Some mandatory additional fields are not provided","7001":"Invalid additional fields data","7002":"DB problem to save Additional fields"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record":{"post":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionrecordCreateSchema"}}],"summary":"Creates a new Subscription record","last_modified_date":"2022.05.03","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordCreateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Please provide plan_id","1001":"Please provide valid plan_id","1002":"Please provide object_id","1003":"Please provide object_type","1004":"Please provide valid record - 1 (licenses) or 2 (seats)","1005":"Please provide start_date","1006":"Please provide valid start_date - Y-m-d (e.g. 2016-12-31)","1007":"Please provide availability","1008":"Please provide valid status - 1 (active) or 2 (inactive)","1009":"There cannot be 2 different subscription records with the same: plan ID, type, availability, price, record type and object ID","1010":"Invalid items data","1011":"Model validation errors (e.g. \"Price must be a number.\")","1012":"Please provide selection_status","1013":"Please provide valid selection_status 1 or 2","9000":"Subscription app is not activated"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record","parameters":[{"in":"query","name":"record_id","type":"integer","required":false,"description":"Subscription record ID"},{"in":"query","name":"record_name","type":"string","required":false,"description":"Subscription record name"},{"in":"query","enum":["1","2"],"name":"type","type":"integer","required":false,"description":"Filter of subscription type: 1 = licence, 2 = seats"},{"in":"query","name":"my_records","type":"boolean","required":false,"description":"If set to true then filter only records bought by the user. Default: false"},{"in":"query","name":"code","type":"string","required":false,"description":"Subscription record code"},{"in":"query","enum":["record_id","record_name","code","create_on"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - record_id"},{"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"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"},{"in":"query","name":"filters","type":"string","required":false,"description":"serialize object containing list of filters and their options. Supported filters: code, sold_to, bundle_name, plan_name, plan_code, bundle_code, end_date, created_on, price, remaining, renewalCount, assigned, record_type, status"}],"summary":"List Subscription records","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordIndexResponse"}},"400":{"description":"General Error","error_codes":{"9000":"Subscription app is not activated"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."}}}},"/learn/v1/sub_record/{record_id}/renew":{"put":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/renew","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionrecordRenewSchema"}},{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of the original subscription record"}],"summary":"Renew a new Subscription record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordRenewResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid parameter - record_id","1002":"Missing parameter - endDate"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/{record_id}":{"delete":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}","parameters":[{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of the subscription record"}],"summary":"Delete a Subscription record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - record_id.","1001":"Can NOT delete Subscription records with associated users","9000":"Subscription app is not activated"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"put":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateSchema"}},{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of the subscription record"}],"summary":"Updates a Subscription record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - record_id.","1001":"Please provide valid plan_id","1002":"Please provide valid record_type","1003":"Please provide valid start_date - Y-m-d (e.g. 2016-12-31)","1004":"Please provide valid status - 1 (active) or 2 (inactive)","1006":"Invalid items data","1007":"Nothing to update. Please provide needed parameters to update DB.","1008":"Model validation errors (e.g. \"Price must be a number.\")","1009":"Please provide valid selection_status 1 or 2","1010":"Please provide valid end_date - Y-m-d (e.g. 2016-12-31)","1011":"Impossible to change availability for single license transaction","9000":"Subscription app is not activated"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}","parameters":[{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of the subscription record"}],"summary":"View a Subscription record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordViewResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - record_id.","9000":"Subscription app is not activated"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/{record_id}/item":{"post":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/item","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItemSchema"}},{"in":"path","name":"record_id","type":"integer","required":true,"description":"Subscription record ID"}],"summary":"Creates a new subscription record item","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItemResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - record_id.","1071":"Missing parameter - item_type.","1072":"Invalid parameter - item_type.","1073":"Missing parameter - item_id.","1074":"Invalid parameter - item_id.","1075":"Item already exist."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/item","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsSchema"}},{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of subscription record to fetch"}],"summary":"Deletes subscription record items","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - record_id.","1081":"Missing parameter - item_ids."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/{record_id}/item/{item_id}":{"delete":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/item/{item_id}","parameters":[{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of subscription record to fetch"},{"in":"path","name":"item_id","type":"integer","required":true,"description":"ID of subscription record item to fetch"}],"summary":"Deletes subscription record item","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - record_id.","1081":"Invalid parameter - item_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/{record_id}/get_users":{"get":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/get_users","parameters":[{"in":"path","name":"record_id","type":"integer","required":true,"description":"Subscription record ID"},{"in":"query","enum":["user_name","first_name","last_name","email"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - user_name"},{"in":"query","enum":["asc","desc"],"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"},{"in":"query","name":"get_only_associated_users","type":"integer","required":false,"description":"if 1 return only users who are associated. Optional 0, 1 default 0"},{"in":"query","name":"inactive","type":"boolean","required":false,"description":"include inactive users in the result set (default: true)"}],"summary":"Retrieves all users by Subscription record ID","last_modified_date":"2022.07.14","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordGetUsersResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/{record_id}/terminate":{"put":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/terminate","parameters":[{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of the subscription record"}],"summary":"Terminates a Subscription record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordTerminateResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Invalid parameter - record_id","1001":"Invalid Purchase type","1002":"Invalid Renewal type","1003":"DB problem to terminate Subscrtiption record"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/{record_id}/get_associated_users":{"get":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/get_associated_users","parameters":[{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of the record"},{"in":"query","enum":["username","first_name","last_name","email"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - first_name"},{"in":"query","enum":["asc","desc"],"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"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in first name, last name and username of the users"}],"summary":"Returns list of users associated to given record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordGetAssociatedUsersResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/{record_id}/unassociate_users":{"put":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/unassociate_users","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionrecordUnassociateUsersSchema"}},{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of the record"}],"summary":"Unassociate users from record","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordUnassociateUsersResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/batch":{"post":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionrecordBatchSchema"}}],"summary":"Batch import for subscription bundles visibility","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordBatchResponse"}},"400":{"description":"General Error","error_codes":{"1102":"No items to be imported","1103":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/items/batch":{"post":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/items/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsL2Schema"}}],"summary":"Batch creates a new subscription record item","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsL2Response"}},"400":{"description":"General Error","error_codes":{"1102":"No items to be imported","1103":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_record/{record_id}/resources":{"get":{"tags":["SubscriptionRecord"],"operationId":"SubscriptionRecord./learn/v1/sub_record/{record_id}/resources","parameters":[{"in":"path","name":"record_id","type":"integer","required":true,"description":"ID of the record"},{"in":"query","enum":["name","code","description"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - name"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, 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, default defined in platform"},{"in":"query","name":"search_text","type":"string","required":false,"description":"Text to search in name, code and description of the course/lp, max length - 200"}],"summary":"Returns the list of courses and learning plans relative to a record id visible to the user","last_modified_date":"2022.10.06","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionrecordGetResourcesResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_seat_association":{"post":{"tags":["SubscriptionSeatAssociation"],"operationId":"SubscriptionSeatAssociation./learn/v1/sub_seat_association","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateSchema"}}],"summary":"Creates a new subscription seat association","last_modified_date":"2022.09.26","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateResponse"}},"400":{"description":"General Error","error_codes":{"1060":"Missing parameter - record_id.","1061":"Invalid parameter - record_id.","1062":"Please provide user_ids and/or branch_ids and/or group_ids.","1064":"No allowed users to add.","1065":"The count of users is exceed limit of remaining availability.","1066":"Invalid parameter - seat_end_date.","1067":"License not active yet."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["SubscriptionSeatAssociation"],"operationId":"SubscriptionSeatAssociation./learn/v1/sub_seat_association","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationDeleteSchema"}}],"summary":"Deletes one or more subscription seat associations","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationDeleteResponse"}},"400":{"description":"General Error","error_codes":{"1060":"Missing parameter - record_id.","1061":"Invalid parameter - record_id.","1063":"Missing parameter - user_ids or branch_ids or group_ids.","1064":"No allowed users to un-assign."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionSeatAssociation"],"operationId":"SubscriptionSeatAssociation./learn/v1/sub_seat_association","parameters":[{"in":"query","name":"record_id","type":"integer","required":false,"description":"Filter returned seats by subscription record"},{"in":"query","collectionFormat":"brackets","items":{"type":"string"},"name":"record_name","type":"array","required":false,"description":"Search text in the record name. Default empty array. OR is performed across array items"},{"in":"query","enum":["id","date","status"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id."},{"in":"query","enum":["asc","desc"],"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"},{"in":"query","name":"seat_status","type":"integer","required":false,"description":"Can get the following values: 1: "in_use", 2: "expired", 3: "cancelled". Default value-> all"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"}],"summary":"Retrieves all subscription seat associations, filtered on input parameters","last_modified_date":"","description":"All filter parameters are optional. If record_name is searched, then an OR operation is performed. If other filter parameters are provided, then an \"AND\" is performed across the other parameters.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationIndexResponse"}},"400":{"description":"General Error","error_codes":{"1060":"Invalid parameter - seat_status.","1061":"Invalid parameter - record_id."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_seat_association/multiple":{"post":{"tags":["SubscriptionSeatAssociation"],"operationId":"SubscriptionSeatAssociation./learn/v1/sub_seat_association/multiple","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateMultipleSchema"}}],"summary":"Creates a new subscription seat association","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateMultipleResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Please provide at least one item","1002":"Something went wrong","1003":"The count of users exceed limit of remaining availability of Subscription Plan {plan name}"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_seat_association/{seat_id}":{"put":{"tags":["SubscriptionSeatAssociation"],"operationId":"SubscriptionSeatAssociation./learn/v1/sub_seat_association/{seat_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationUpdateSchema"}},{"in":"path","name":"seat_id","type":"integer","required":true,"description":"ID of the seat association"}],"summary":"Update a subscription seat association","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationUpdateResponse"}},"400":{"description":"General Error","error_codes":{"1060":"Invalid parameter - seat_id.","1061":"You don't have permissions to perform this action.","1062":"Invalid parameter - seat_end_date.","1063":"Invalid parameter - status."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["SubscriptionSeatAssociation"],"operationId":"SubscriptionSeatAssociation./learn/v1/sub_seat_association/{seat_id}","parameters":[{"in":"path","name":"seat_id","type":"integer","required":true,"description":"ID of the seat association"}],"summary":"View a subscription seat association","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationViewResponse"}},"400":{"description":"General Error","error_codes":{"1060":"Invalid parameter - seat_id.","1061":"You don't have permissions to perform this action."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_seat_association/user/{user_id}":{"get":{"tags":["SubscriptionSeatAssociation"],"operationId":"SubscriptionSeatAssociation./learn/v1/sub_seat_association/user/{user_id}","parameters":[{"in":"path","name":"user_id","type":"integer","required":true,"description":"User ID"},{"in":"query","enum":["id","date","status"],"name":"sort_attr","type":"string","required":false,"description":"Sort by this field, default value - id."},{"in":"query","enum":["asc","desc"],"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"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previosuly obtained by passing get_cursor=1"},{"in":"query","name":"get_cursor","type":"integer","required":false,"description":"Generate and return "cursor" and prebuilt navigational "_links". Default=0"}],"summary":"Retrieves all subscription seat associations, filtered on input parameters","last_modified_date":"","description":"All filter parameters are optional. If record_name is searched, then an OR operation is performed. If other filter parameters are provided, then an \"AND\" is performed across the other parameters.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationListSeatsByUserResponse"}},"400":{"description":"General Error","error_codes":{"1060":"Invalid parameter - user_id.","1061":"You don't have permissions to view this user seats."}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/sub_seat_association/batch":{"post":{"tags":["SubscriptionSeatAssociation"],"operationId":"SubscriptionSeatAssociation./learn/v1/sub_seat_association/batch","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchSchema"}}],"summary":"Batch import for subscription seat association","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchResponse"}},"400":{"description":"General Error","error_codes":{"1102":"No items to be imported","1103":"Maximum number of records exceeded"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/survey/{id_object}/answer":{"get":{"tags":["Survey"],"operationId":"Survey./learn/v1/survey/{id_object}/answer","parameters":[{"in":"path","name":"id_object","type":"integer","required":true,"description":"Poll ID to export, expected integer grater than zero, limit to 18 digits"},{"in":"query","name":"id_course","type":"integer","required":false,"description":"ID of the course"},{"in":"query","name":"page","type":"integer","required":false,"description":"Page number to return (starting from 1)"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of results per page"}],"summary":"Retrieves survey data (questions, answers) grouped by user","last_modified_date":"","description":"id_object -> id_poll is mandatory.","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnSurveySurveyanswerResponse"}},"400":{"description":"General Error","error_codes":{"1000":"Empty id_object (missing or invalid input parameter)","1001":"id_object or answers not found (no data to export: missing id_poll or no answers from users yet)"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/tests":{"get":{"tags":["Tests"],"operationId":"Tests./learn/v1/tests","parameters":[{"in":"query","name":"id_course","type":"integer","required":false,"description":"Course ID"},{"in":"query","name":"id_user","type":"integer","required":false,"description":"Internal user ID"},{"in":"query","enum":["completed","to_evaluate"],"name":"status","type":"string","required":false,"description":"Return test with given status. Default: completed"},{"in":"query","enum":["id_course","completion_date"],"name":"sort_attr","type":"string","required":false,"description":"Sort result criteria. Default: completion_date"},{"in":"query","enum":["asc","desc"],"name":"sort_dir","type":"string","required":false,"description":"Sorting Direction: asc = Ascending, desc = descending, 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. Default to the platform setting for pagination"},{"in":"query","name":"cursor","type":"string","required":false,"description":"Data set navigational cursor previously obtained by passing get_cursor=1"}],"summary":"Get completed or not completed \"test\" Learning Objects","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnTestsIndexResponse"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/accounts":{"post":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/accounts","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarCreateWebinarAccountSchema"}}],"summary":"Create a Webinar Account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarCreateWebinarAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Already existent app_key for the provided tool","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/accounts","parameters":[{"in":"query","name":"term","type":"string","required":false,"description":"The account name. Empty by default."},{"in":"query","name":"provider","type":"array","required":false,"description":"A provider list. Supported ['zoomv2meeting', 'zoomv2webinar']"},{"in":"query","name":"page","type":"integer","required":false,"description":"Number of the page to read. Default value: 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of items per page to read. Default value: 10"},{"in":"query","name":"sort","type":"string","required":false,"description":"Sorting attribute (eg. field_name.direction). Default value: name.asc"}],"summary":"Get Account list","last_modified_date":"","description":"Get the account list","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarListWebinarAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid sort parameter","1003":"Invalid page parameter","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/accounts/{account_id}":{"put":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/accounts/{account_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAccountSchema"}}],"summary":"Update a Webinar Account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Already existent app_key for the provided tool","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/accounts/{account_id}","parameters":[{"in":"path","name":"account_id","type":"integer","required":true,"description":"ID of the account that needs to be deleted"}],"summary":"Delete a Webinar Account. (Actually it works just using Zoom.us)","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid provider"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/accounts/{account_id}/pair":{"post":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/accounts/{account_id}/pair","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarPairWebinarAccountSchema"}},{"in":"path","name":"account_id","type":"integer","required":true,"description":"The account id"}],"summary":"Pair a Webinar Account with webinar provider (actually it works just using Zoom.us)","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarPairWebinarAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid provider","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/adobeconnect/accounts":{"post":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/adobeconnect/accounts","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarCreateWebinarAdobeconnectAccountSchema"}}],"summary":"Create a Webinar Account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarCreateWebinarAdobeconnectAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Already existent admin_username for the provided tool","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/adobeconnect/accounts","parameters":[{"in":"query","name":"term","type":"string","required":false,"description":"The account name. Empty by default."},{"in":"query","name":"provider","type":"array","required":false,"description":"A provider list. Supported ['zoomv2meeting', 'zoomv2webinar']"},{"in":"query","name":"page","type":"integer","required":false,"description":"Number of the page to read. Default value: 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of items per page to read. Default value: 10"},{"in":"query","name":"sort","type":"string","required":false,"description":"Sorting attribute (eg. field_name.direction). Default value: name.asc"}],"summary":"Get Account list","last_modified_date":"","description":"Get the account list","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarListWebinarAdobeconnectAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid sort parameter","1003":"Invalid page parameter","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/adobeconnect/accounts/{account_id}":{"put":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/adobeconnect/accounts/{account_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAdobeconnectAccountSchema"}}],"summary":"Update a Webinar Account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAdobeconnectAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Already existent admin_username for the provided tool","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/adobeconnect/accounts/{account_id}","parameters":[{"in":"path","name":"account_id","type":"integer","required":true,"description":"ID of the account that needs to be deleted"}],"summary":"Delete a Webinar Account. (Actually it works just using Zoom.us)","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAdobeconnectAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid provider"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/gotomeeting/webinar/accounts":{"post":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/gotomeeting/webinar/accounts","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarCreateWebinarGotomeetingAccountSchema"}}],"summary":"Create a Webinar Account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarCreateWebinarGotomeetingAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Already existent app_key for the provided tool","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/gotomeeting/accounts/{account_id}":{"put":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/gotomeeting/accounts/{account_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarUpdateWebinarGotomeetingAccountSchema"}}],"summary":"Update a Webinar Account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarUpdateWebinarGotomeetingAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Already existent app_key for the provided tool","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/gotomeeting/accounts/{account_id}","parameters":[{"in":"path","name":"account_id","type":"integer","required":true,"description":"ID of the account that needs to be deleted"}],"summary":"Delete a Webinar Account. (Actually it works just using Zoom.us)","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarDeleteWebinarGotomeetingAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid provider"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/gotomeeting/accounts":{"get":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/gotomeeting/accounts","parameters":[{"in":"query","name":"term","type":"string","required":false,"description":"The account name. Empty by default."},{"in":"query","name":"provider","type":"array","required":false,"description":"A provider list. Supported ['zoomv2meeting', 'zoomv2webinar']"},{"in":"query","name":"page","type":"integer","required":false,"description":"Number of the page to read. Default value: 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of items per page to read. Default value: 10"},{"in":"query","name":"sort","type":"string","required":false,"description":"Sorting attribute (eg. field_name.direction). Default value: name.asc"}],"summary":"Get Account list","last_modified_date":"","description":"Get the account list","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarListWebinarGotomeetingAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid sort parameter","1003":"Invalid page parameter","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/gotomeeting/accounts/{account_id}/pair":{"post":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/gotomeeting/accounts/{account_id}/pair","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarPairGotomeetingWebinarAccountSchema"}},{"in":"path","name":"account_id","type":"integer","required":true,"description":"The account id"}],"summary":"Pair a Webinar Account with webinar provider (actually it works just using Zoom.us)","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarPairGotomeetingWebinarAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid provider","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/msteams/accounts":{"post":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/msteams/accounts","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarCreateWebinarMsteamsAccountSchema"}}],"summary":"Create a Webinar Account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarCreateWebinarMsteamsAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Already existent app_key for the provided tool","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/msteams/accounts","parameters":[{"in":"query","name":"term","type":"string","required":false,"description":"The account name. Empty by default."},{"in":"query","name":"provider","type":"array","required":false,"description":"A provider list. Supported ['msteamsv2meeting']"},{"in":"query","name":"page","type":"integer","required":false,"description":"Number of the page to read. Default value: 1"},{"in":"query","name":"page_size","type":"integer","required":false,"description":"Number of items per page to read. Default value: 10"},{"in":"query","name":"sort","type":"string","required":false,"description":"Sorting attribute (eg. field_name.direction). Default value: name.asc"}],"summary":"Get Account list","last_modified_date":"","description":"Get the account list","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarListWebinarMsteamsAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid sort parameter","1003":"Invalid page parameter","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}}},"/learn/v1/webinar/msteams/accounts/{account_id}":{"put":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/msteams/accounts/{account_id}","parameters":[{"in":"body","name":"body","description":"Raw Body","required":false,"schema":{"$ref":"#/definitions/LearnWebinarUpdateWebinarMsteamsAccountSchema"}}],"summary":"Update a Webinar Account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarUpdateWebinarMsteamsAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Already existent app_key for the provided tool","2000":"Generic error"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"delete":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/msteams/accounts/{account_id}","parameters":[{"in":"path","name":"account_id","type":"integer","required":true,"description":"ID of the account that needs to be deleted"}],"summary":"Delete a Webinar Account.","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarDeleteWebinarMsteamsAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Invalid provider"}},"500":{"description":"Internal server error"},"401":{"description":"Your request was made with invalid credentials."},"403":{"description":"Permission denied"}}},"get":{"tags":["Webinar"],"operationId":"Webinar./learn/v1/webinar/msteams/accounts/{account_id}","parameters":[{"in":"path","name":"account_id","type":"integer","required":true,"description":"The id of the rule"}],"summary":"Get a single Webinar MSTeams account","last_modified_date":"","description":"","responses":{"200":{"description":"Operation Successful","schema":{"$ref":"#/definitions/LearnWebinarViewWebinarMsteamsAccountResponse"}},"400":{"description":"General Error","error_codes":{"1001":"Invalid or missing parameters","1002":"Account not found"}},"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."}}},"LearnAssignmentUploadStatusResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnAssignmentUploadStatusData","description":"Success or failure response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnAssignmentUploadStatusLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnAssignmentUploadStatusData":{"required":["uploaded"],"properties":{"uploaded":{"type":"boolean","description":"True if the file exists"}}},"LearnAssignmentUploadStatusLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnAssignmentUploadStatusSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnAssignmentUploadStatusGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnAssignmentUploadStatusFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnAssignmentUploadStatusLast","description":"Link to the last page"}}},"LearnAssignmentUploadStatusSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnAssignmentUploadStatusGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnAssignmentUploadStatusFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnAssignmentUploadStatusLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCallbackTranscoderSchema":{"type":"object","required":["hash_id","message"],"properties":{"hash_id":{"type":"string","description":"LMS generated hash ID, to identify the job in the LMS DB"},"message":{"type":"array","description":"Job related message - a complex array of data, specific for different cases","items":{"$ref":"#/definitions/LearnCallbackTranscoderMessage"}},"context":{"type":"array","description":"Lambda function execution context, usefull for diagnostic purposes","items":{"$ref":"#/definitions/LearnCallbackTranscoderContext"}}}},"LearnCallbackTranscoderMessage":{},"LearnCallbackTranscoderContext":{},"LearnCallbackTranscoderResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response Data","items":{"$ref":"#/definitions/LearnCallbackTranscoderData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCallbackTranscoderLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCallbackTranscoderData":{},"LearnCallbackTranscoderLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCallbackTranscoderSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCallbackTranscoderGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCallbackTranscoderFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCallbackTranscoderLast","description":"Link to the last page"}}},"LearnCallbackTranscoderSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCallbackTranscoderGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCallbackTranscoderFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCallbackTranscoderLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentPublicCatalogContentResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentData","description":"Data wrapper"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentPublicCatalogContentData":{"required":["items"],"properties":{"items":{"type":"array","description":"Another wrapper","items":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentItems"}}}},"LearnCatalogcontentPublicCatalogContentItems":{"required":["data","extra_data"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentDataL2","description":"Catalog items data"},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentExtraData","description":"Catalog data"}}},"LearnCatalogcontentPublicCatalogContentDataL2":{"required":["count","has_more_data","current_page","total_page_count","total_count","sort","sub_items"],"properties":{"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True when 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 number of the current page"},"total_page_count":{"type":"integer","description":"Total number of pages"},"total_count":{"type":"integer","description":"Total number of items"},"sort":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentSort"}},"sub_items":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentSubItems"}}}},"LearnCatalogcontentPublicCatalogContentSort":{},"LearnCatalogcontentPublicCatalogContentSubItems":{"required":["item_id","item_type","item_code","item_name","item_slug","item_create_date","item_policy","item_can_enroll","is_opened","course_type","item_thumbnail","item_price","price_status","access_status"],"properties":{"item_id":{"type":"string","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_type_int":{"type":"string","description":""},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_slug":{"type":"string","description":"Item slug"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"string","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnCatalogcontentPublicCatalogContentMultiLanguages"}},"item_create_date":{"type":"string","description":"Item creation date"},"number_of_courses":{"type":"string","description":"Number of courses (only available for Learning plans, otherwise NULL will be returned)"},"item_date_end":{"type":"string","description":"Item date end (only available for Courses, otherwise NULL will be returned)"},"item_visibility":{"type":"string","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"string","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"string","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free)"},"is_opened":{"type":"string","description":"Is course opened for subsription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"course_type":{"type":"string","description":"Course type (learning_plan for Learning plans)"},"duration":{"type":"string","description":"Item duration"},"waiting":{"type":"boolean","description":""},"item_rating":{"type":"integer","description":"Item rating (only available for Courses, otherwise NULL will be returned)"},"partner_fields":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentPartnerFields","description":"Additional fields related to the associated partner"},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"item_price":{"type":"string","description":"Item price"},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"},"prices":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentPrices","description":"The object that contains the course prices"},"access_status":{"type":"integer","description":"1 - enabled, 2 - disabled, 3 - expired, NULL - n/a (for Learning plans)"},"is_affiliate":{"type":"boolean","description":""},"is_user_subscribed":{"type":"integer","description":""},"is_user_enrolled":{"type":"string","description":""},"is_new":{"type":"boolean","description":""},"total_duration":{"type":"integer","description":"Total duration of courses in LP"},"item_ecommerce":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentItemEcommerce","description":"The item ecommerce pricing system"}}},"LearnCatalogcontentPublicCatalogContentMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnCatalogcontentPublicCatalogContentPartnerFields":{},"LearnCatalogcontentPublicCatalogContentPrices":{"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."}}},"LearnCatalogcontentPublicCatalogContentItemEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The item price from the external pricing system"},"discounted_price":{"type":"string","description":"The item discounted price from the external pricing system"},"currency":{"type":"string","description":"The item currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The item currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The item currency from the external pricing system"}}},"LearnCatalogcontentPublicCatalogContentExtraData":{"required":["id","name","description","code","entries_sort_attr","entries_sort_dir","slug"],"properties":{"id":{"type":"string","description":"ID of the requested catalog"},"name":{"type":"string","description":"Name of the requested catalog"},"description":{"type":"string","description":"Description of the requested catalog"},"code":{"type":"string","description":"Code of the requested catalog"},"entries_sort_attr":{"type":"string","description":"current sorting attribute"},"entries_sort_dir":{"description":"current sorting direction","enum":["asc","desc"],"type":"string"},"slug":{"type":"string","description":"Slug derived from catalog name"}}},"LearnCatalogcontentPublicCatalogContentLinks":{"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentLast","description":"Link to the last page"}}},"LearnCatalogcontentPublicCatalogContentSelf":{"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentPublicCatalogContentGoto":{"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentPublicCatalogContentFirst":{"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentPublicCatalogContentLast":{"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentPublicCatalogContentsPreviewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentPublicCatalogContentsPreviewData":{"required":["items","extra_data"],"properties":{"items":{"type":"array","description":"List of retrieved catalogs","items":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewItems"}},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewExtraDataL2","description":"cursor pagination data"}}},"LearnCatalogcontentPublicCatalogContentsPreviewItems":{"required":["data","extra_data"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewDataL2","description":"Catalog items data"},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewExtraData","description":"Catalog data"}}},"LearnCatalogcontentPublicCatalogContentsPreviewDataL2":{"required":["sub_items"],"properties":{"sub_items":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewSubItems"}}}},"LearnCatalogcontentPublicCatalogContentsPreviewSubItems":{"required":["item_id","item_type","item_code","item_name","item_slug","item_create_date","item_policy","item_can_enroll","is_opened","course_type","item_thumbnail","item_price","price_status","access_status"],"properties":{"item_id":{"type":"string","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_type_int":{"type":"string","description":""},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_slug":{"type":"string","description":"Item slug"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"string","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnCatalogcontentPublicCatalogContentsPreviewMultiLanguages"}},"item_create_date":{"type":"string","description":"Item creation date"},"number_of_courses":{"type":"string","description":"Number of courses (only available for Learning plans, otherwise NULL will be returned)"},"item_date_end":{"type":"string","description":"Item date end (only available for Courses, otherwise NULL will be returned)"},"item_visibility":{"type":"string","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"string","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"string","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free)"},"is_opened":{"type":"string","description":"Is course opened for subsription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"course_type":{"type":"string","description":"Course type (learning_plan for Learning plans)"},"duration":{"type":"string","description":"Item duration"},"waiting":{"type":"boolean","description":""},"item_rating":{"type":"integer","description":"Item rating (only available for Courses, otherwise NULL will be returned)"},"partner_fields":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewPartnerFields","description":"Additional fields related to the associated partner"},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"item_price":{"type":"string","description":"Item price"},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"},"prices":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewPrices","description":"The object that contains the course prices"},"access_status":{"type":"integer","description":"1 - enabled, 2 - disabled, 3 - expired, NULL - n/a (for Learning plans)"},"is_affiliate":{"type":"boolean","description":""},"is_user_subscribed":{"type":"integer","description":""},"is_user_enrolled":{"type":"string","description":""},"is_new":{"type":"boolean","description":""},"total_duration":{"type":"integer","description":"Total duration of courses in LP"},"item_ecommerce":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewItemEcommerce","description":"The item ecommerce pricing system"}}},"LearnCatalogcontentPublicCatalogContentsPreviewMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnCatalogcontentPublicCatalogContentsPreviewPartnerFields":{},"LearnCatalogcontentPublicCatalogContentsPreviewPrices":{"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."}}},"LearnCatalogcontentPublicCatalogContentsPreviewItemEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The item price from the external pricing system"},"discounted_price":{"type":"string","description":"The item discounted price from the external pricing system"},"currency":{"type":"string","description":"The item currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The item currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The item currency from the external pricing system"}}},"LearnCatalogcontentPublicCatalogContentsPreviewExtraData":{"required":["id","name","description","code","entries_sort_attr","entries_sort_dir","slug"],"properties":{"id":{"type":"string","description":"ID of the catalog"},"name":{"type":"string","description":"Name of the catalog"},"description":{"type":"string","description":"Description of the catalog"},"code":{"type":"string","description":"Code of the catalog"},"entries_sort_attr":{"type":"string","description":"Sorting attribute for the catalog's courses and LPs"},"entries_sort_dir":{"type":"string","description":"Either "asc" or "desc""},"slug":{"type":"string","description":"Slug derived from catalog name"}}},"LearnCatalogcontentPublicCatalogContentsPreviewExtraDataL2":{"required":["cursor","page_size","has_more_data"],"properties":{"cursor":{"type":"integer","description":""},"page_size":{"type":"integer","description":""},"has_more_data":{"type":"boolean","description":""}}},"LearnCatalogcontentPublicCatalogContentsPreviewLinks":{"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogContentsPreviewLast","description":"Link to the last page"}}},"LearnCatalogcontentPublicCatalogContentsPreviewSelf":{"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentPublicCatalogContentsPreviewGoto":{"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentPublicCatalogContentsPreviewFirst":{"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentPublicCatalogContentsPreviewLast":{"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentPublicCatalogsContentResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentPublicCatalogsContentData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of retrieved catalogs","items":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentItems"}}}},"LearnCatalogcontentPublicCatalogsContentItems":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentDataL2","description":"Catalog items data"}}},"LearnCatalogcontentPublicCatalogsContentDataL2":{"required":["sort","count","has_more_data","current_page","current_page_size","total_page_count","total_count","sub_items"],"properties":{"sort":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentSort"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True when 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 number of the current page"},"current_page_size":{"type":"integer","description":"Current amount of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages"},"total_count":{"type":"integer","description":"Total number of items"},"sub_items":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentSubItems"}}}},"LearnCatalogcontentPublicCatalogsContentSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"current sorting attribute"},"sort_dir":{"description":"current sorting direction","enum":["asc","desc"],"type":"string"}}},"LearnCatalogcontentPublicCatalogsContentSubItems":{"required":["item_id","item_type","item_code","item_name","item_slug","item_create_date","item_policy","item_can_enroll","is_opened","course_type","item_thumbnail","item_price","price_status","access_status"],"properties":{"item_id":{"type":"string","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_type_int":{"type":"string","description":""},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_slug":{"type":"string","description":"Item slug"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"string","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnCatalogcontentPublicCatalogsContentMultiLanguages"}},"item_create_date":{"type":"string","description":"Item creation date"},"number_of_courses":{"type":"string","description":"Number of courses (only available for Learning plans, otherwise NULL will be returned)"},"item_date_end":{"type":"string","description":"Item date end (only available for Courses, otherwise NULL will be returned)"},"item_visibility":{"type":"string","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"string","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"string","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free)"},"is_opened":{"type":"string","description":"Is course opened for subsription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"course_type":{"type":"string","description":"Course type (learning_plan for Learning plans)"},"duration":{"type":"string","description":"Item duration"},"waiting":{"type":"boolean","description":""},"item_rating":{"type":"integer","description":"Item rating (only available for Courses, otherwise NULL will be returned)"},"partner_fields":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentPartnerFields","description":"Additional fields related to the associated partner"},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"item_price":{"type":"string","description":"Item price"},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"},"prices":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentPrices","description":"The object that contains the course prices"},"access_status":{"type":"integer","description":"1 - enabled, 2 - disabled, 3 - expired, NULL - n/a (for Learning plans)"},"is_affiliate":{"type":"boolean","description":""},"is_user_subscribed":{"type":"integer","description":""},"is_user_enrolled":{"type":"string","description":""},"is_new":{"type":"boolean","description":""},"total_duration":{"type":"integer","description":"Total duration of courses in LP"},"item_ecommerce":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentItemEcommerce","description":"The item ecommerce pricing system"}}},"LearnCatalogcontentPublicCatalogsContentMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnCatalogcontentPublicCatalogsContentPartnerFields":{},"LearnCatalogcontentPublicCatalogsContentPrices":{"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."}}},"LearnCatalogcontentPublicCatalogsContentItemEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The item price from the external pricing system"},"discounted_price":{"type":"string","description":"The item discounted price from the external pricing system"},"currency":{"type":"string","description":"The item currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The item currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The item currency from the external pricing system"}}},"LearnCatalogcontentPublicCatalogsContentLinks":{"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentPublicCatalogsContentLast","description":"Link to the last page"}}},"LearnCatalogcontentPublicCatalogsContentSelf":{"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentPublicCatalogsContentGoto":{"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentPublicCatalogsContentFirst":{"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentPublicCatalogsContentLast":{"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentPublicGeneralCatalogContentResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicGeneralCatalogContentData","description":"Catalog items data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCatalogcontentPublicGeneralCatalogContentData":{"required":["count","has_more_data","current_page","current_page_size","total_page_count","total_count","items","extra_data"],"properties":{"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True when 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":"Size of the returned page"},"total_page_count":{"type":"integer","description":"Total number of pages"},"total_count":{"type":"integer","description":"Total number of items"},"items":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentPublicGeneralCatalogContentItems"}},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentPublicGeneralCatalogContentExtraData","description":"Catalog data"}}},"LearnCatalogcontentPublicGeneralCatalogContentItems":{"required":["item_id","item_type","item_code","item_name","item_slug","item_create_date","item_policy","item_can_enroll","is_opened","course_type","item_thumbnail","item_price","price_status","access_status"],"properties":{"item_id":{"type":"string","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_type_int":{"type":"string","description":""},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_slug":{"type":"string","description":"Item slug"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"string","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnCatalogcontentPublicGeneralCatalogContentMultiLanguages"}},"item_create_date":{"type":"string","description":"Item creation date"},"number_of_courses":{"type":"string","description":"Number of courses (only available for Learning plans, otherwise NULL will be returned)"},"item_date_end":{"type":"string","description":"Item date end (only available for Courses, otherwise NULL will be returned)"},"item_visibility":{"type":"string","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"string","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"string","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free)"},"is_opened":{"type":"string","description":"Is course opened for subscription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"course_type":{"type":"string","description":"Course type (learning_plan for Learning plans)"},"duration":{"type":"string","description":"Item duration"},"waiting":{"type":"boolean","description":""},"item_rating":{"type":"integer","description":"Item rating (only available for Courses, otherwise NULL will be returned)"},"partner_fields":{"$ref":"#/definitions/LearnCatalogcontentPublicGeneralCatalogContentPartnerFields","description":"Additional fields related to the associated partner"},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"item_price":{"type":"string","description":"Item price"},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"},"prices":{"$ref":"#/definitions/LearnCatalogcontentPublicGeneralCatalogContentPrices","description":"The object that contains the course prices"},"access_status":{"type":"integer","description":"1 - enabled, 2 - disabled, 3 - expired, NULL - n/a (for Learning plans)"},"is_affiliate":{"type":"boolean","description":""},"is_user_subscribed":{"type":"integer","description":""},"is_user_enrolled":{"type":"string","description":""},"is_new":{"type":"boolean","description":""},"total_duration":{"type":"integer","description":"Total duration of courses in LP"},"item_ecommerce":{"$ref":"#/definitions/LearnCatalogcontentPublicGeneralCatalogContentItemEcommerce","description":"The item ecommerce pricing system"}}},"LearnCatalogcontentPublicGeneralCatalogContentMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnCatalogcontentPublicGeneralCatalogContentPartnerFields":{},"LearnCatalogcontentPublicGeneralCatalogContentPrices":{"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."}}},"LearnCatalogcontentPublicGeneralCatalogContentItemEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The item price from the external pricing system"},"discounted_price":{"type":"string","description":"The item discounted price from the external pricing system"},"currency":{"type":"string","description":"The item currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The item currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The item currency from the external pricing system"}}},"LearnCatalogcontentPublicGeneralCatalogContentExtraData":{"required":["list_type","sort_attr","sort_dir"],"properties":{"list_type":{"type":"integer","description":""},"sort_attr":{"type":"string","description":"current sorting attribute"},"sort_dir":{"description":"current sorting direction","enum":["asc","desc"],"type":"string"}}},"LearnCatalogcontentInternalCalendarCatalogsContentResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarCatalogsContentData","description":"List of all retrieved courses"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarCatalogsContentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentInternalCalendarCatalogsContentData":{"required":["items"],"properties":{"items":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarCatalogsContentItems","description":"Array of course info objects"}}},"LearnCatalogcontentInternalCalendarCatalogsContentItems":{"required":["course_id","course_type","course_name","course_slug","course_description","event_date_start","event_date_end","all_day","location","is_paid","event_name"],"properties":{"course_id":{"type":"integer","description":"ID of the course"},"course_type":{"type":"string","description":"Course type. Options: "classroom""},"course_name":{"type":"string","description":"Course name"},"course_slug":{"type":"string","description":"The Slug name (name-with-dashes) of the course"},"course_description":{"type":"string","description":"Course description"},"event_date_start":{"type":"string","description":"The day and time of begin of the event"},"event_date_end":{"type":"string","description":"The day and time of end of the event"},"all_day":{"type":"boolean","description":"Is it takes all day long. Options: 1 - true, 0 - false"},"location":{"type":"string","description":"Session location"},"is_paid":{"type":"boolean","description":"True when a course is on sale"},"event_name":{"type":"string","description":"Name of session on given date"},"physical_location":{"type":"string","description":"Physical event location"},"event_location_type":{"description":"Event location type.","enum":["Flexible","Onsite","Online training"],"type":"string"},"timezone":{"type":"string","description":"Timezone of the event"}}},"LearnCatalogcontentInternalCalendarCatalogsContentLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarCatalogsContentSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarCatalogsContentGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarCatalogsContentFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarCatalogsContentLast","description":"Link to the last page"}}},"LearnCatalogcontentInternalCalendarCatalogsContentSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentInternalCalendarCatalogsContentGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentInternalCalendarCatalogsContentFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentInternalCalendarCatalogsContentLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentInternalCatalogContentResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentData","description":"Data wrapper"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentInternalCatalogContentData":{"required":["items"],"properties":{"items":{"type":"array","description":"Another wrapper","items":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentItems"}}}},"LearnCatalogcontentInternalCatalogContentItems":{"required":["data","extra_data"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentDataL2","description":"Catalog items data"},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentExtraData","description":"Catalog data"}}},"LearnCatalogcontentInternalCatalogContentDataL2":{"required":["count","has_more_data","current_page","current_page_size","total_page_count","total_count","sub_items"],"properties":{"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True when the current page is not the last page"},"cursor":{"type":"string","description":"Unique ID used to temporarily store search parameters"},"current_page":{"type":"total_page_count","description":"Page number of the current page"},"current_page_size":{"type":"integer","description":"The requested page size"},"total_page_count":{"type":"integer","description":"Total number of pages"},"total_count":{"type":"integer","description":"Total number of items"},"sub_items":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentSubItems"}}}},"LearnCatalogcontentInternalCatalogContentSubItems":{"required":["item_id","item_type","item_code","item_name","item_slug","item_create_date","item_policy","item_can_enroll","is_opened","course_type","item_thumbnail","item_price","price_status","access_status"],"properties":{"item_id":{"type":"string","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_type_int":{"type":"string","description":""},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_slug":{"type":"string","description":"Item slug"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"string","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnCatalogcontentInternalCatalogContentMultiLanguages"}},"item_create_date":{"type":"string","description":"Item creation date"},"number_of_courses":{"type":"string","description":"Number of courses (only available for Learning plans, otherwise NULL will be returned)"},"item_date_end":{"type":"string","description":"Item date end (only available for Courses, otherwise NULL will be returned)"},"item_visibility":{"type":"string","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"string","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"string","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free)"},"is_opened":{"type":"string","description":"Is course opened for subsription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"course_type":{"type":"string","description":"Course type (learning_plan for Learning plans)"},"duration":{"type":"string","description":"Item duration"},"waiting":{"type":"boolean","description":""},"item_rating":{"type":"integer","description":"Item rating (only available for Courses, otherwise NULL will be returned)"},"partner_fields":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentPartnerFields","description":"Additional fields related to the associated partner"},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"item_price":{"type":"string","description":"Item price"},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"},"prices":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentPrices","description":"The object that contains the course prices"},"access_status":{"type":"integer","description":"1 - enabled, 2 - disabled, 3 - expired, NULL - n/a (for Learning plans)"},"course_user_status":{"type":"string","description":""},"is_affiliate":{"type":"boolean","description":""},"is_user_subscribed":{"type":"integer","description":""},"is_user_enrolled":{"type":"string","description":""},"is_new":{"type":"boolean","description":""},"total_duration":{"type":"integer","description":"Total duration of courses in LP"},"item_ecommerce":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentItemEcommerce","description":"The item ecommerce pricing system"},"quick_course_launch":{"type":"boolean","description":"Whether the course quick enrollment is active."}}},"LearnCatalogcontentInternalCatalogContentMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnCatalogcontentInternalCatalogContentPartnerFields":{},"LearnCatalogcontentInternalCatalogContentPrices":{"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."}}},"LearnCatalogcontentInternalCatalogContentItemEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The item price from the external pricing system"},"discounted_price":{"type":"string","description":"The item discounted price from the external pricing system"},"currency":{"type":"string","description":"The item currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The item currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The item currency from the external pricing system"}}},"LearnCatalogcontentInternalCatalogContentExtraData":{"required":["id","name","description","code","entries_sort_attr","entries_sort_dir","slug"],"properties":{"id":{"type":"string","description":"ID of the requested catalog"},"name":{"type":"string","description":"Name of the requested catalog"},"description":{"type":"string","description":"Description of the requested catalog"},"code":{"type":"string","description":"Code of the requested catalog"},"entries_sort_attr":{"type":"string","description":"current sorting attribute"},"entries_sort_dir":{"description":"current sorting direction","enum":["asc","desc"],"type":"string"},"slug":{"type":"string","description":"Slug derived from catalog name"}}},"LearnCatalogcontentInternalCatalogContentLinks":{"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentLast","description":"Link to the last page"}}},"LearnCatalogcontentInternalCatalogContentSelf":{"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentInternalCatalogContentGoto":{"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentInternalCatalogContentFirst":{"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentInternalCatalogContentLast":{"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentInternalCatalogContentsPreviewResponse":{"required":["data","version","version","version","extra_data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewExtraDataL3","description":"Catalog data"},"_links":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentInternalCatalogContentsPreviewData":{"required":["items","extra_data"],"properties":{"items":{"type":"array","description":"List of retrieved catalogs","items":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewItems"}},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewExtraDataL2","description":"cursor pagination data"}}},"LearnCatalogcontentInternalCatalogContentsPreviewItems":{"required":["data","extra_data"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewDataL2","description":"Catalog items data"},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewExtraData","description":"Catalog data"}}},"LearnCatalogcontentInternalCatalogContentsPreviewDataL2":{"required":["sub_items"],"properties":{"sub_items":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewSubItems"}}}},"LearnCatalogcontentInternalCatalogContentsPreviewSubItems":{"required":["item_id","item_type","item_code","item_name","item_slug","item_create_date","item_policy","item_can_enroll","is_opened","course_type","item_thumbnail","item_price","price_status","access_status"],"properties":{"item_id":{"type":"string","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_type_int":{"type":"string","description":""},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_slug":{"type":"string","description":"Item slug"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"string","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnCatalogcontentInternalCatalogContentsPreviewMultiLanguages"}},"item_create_date":{"type":"string","description":"Item creation date"},"number_of_courses":{"type":"string","description":"Number of courses (only available for Learning plans, otherwise NULL will be returned)"},"item_date_end":{"type":"string","description":"Item date end (only available for Courses, otherwise NULL will be returned)"},"item_visibility":{"type":"string","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"string","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"string","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free)"},"is_opened":{"type":"string","description":"Is course opened for subsription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"course_type":{"type":"string","description":"Course type (learning_plan for Learning plans)"},"duration":{"type":"string","description":"Item duration"},"waiting":{"type":"boolean","description":""},"item_rating":{"type":"integer","description":"Item rating (only available for Courses, otherwise NULL will be returned)"},"partner_fields":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewPartnerFields","description":"Additional fields related to the associated partner"},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"item_price":{"type":"string","description":"Item price"},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"},"prices":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewPrices","description":"The object that contains the course prices"},"access_status":{"type":"integer","description":"1 - enabled, 2 - disabled, 3 - expired, NULL - n/a (for Learning plans)"},"course_user_status":{"type":"string","description":""},"is_affiliate":{"type":"boolean","description":""},"is_user_subscribed":{"type":"integer","description":""},"is_user_enrolled":{"type":"string","description":""},"is_new":{"type":"boolean","description":""},"total_duration":{"type":"integer","description":"Total duration of courses in LP"},"item_ecommerce":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewItemEcommerce","description":"The item ecommerce pricing system"},"quick_course_launch":{"type":"boolean","description":"Whether the course quick enrollment is active."}}},"LearnCatalogcontentInternalCatalogContentsPreviewMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnCatalogcontentInternalCatalogContentsPreviewPartnerFields":{},"LearnCatalogcontentInternalCatalogContentsPreviewPrices":{"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."}}},"LearnCatalogcontentInternalCatalogContentsPreviewItemEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The item price from the external pricing system"},"discounted_price":{"type":"string","description":"The item discounted price from the external pricing system"},"currency":{"type":"string","description":"The item currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The item currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The item currency from the external pricing system"}}},"LearnCatalogcontentInternalCatalogContentsPreviewExtraData":{"required":["id","name","description","code","entries_sort_attr","entries_sort_dir","slug"],"properties":{"id":{"type":"string","description":"ID of the catalog"},"name":{"type":"string","description":"Name of the catalog"},"description":{"type":"string","description":"Description of the catalog"},"code":{"type":"string","description":"Code of the catalog"},"entries_sort_attr":{"type":"string","description":"Sorting attribute for the catalog's courses and LPs"},"entries_sort_dir":{"type":"string","description":"Either "asc" or "desc""},"slug":{"type":"string","description":"Slug derived from catalog name"}}},"LearnCatalogcontentInternalCatalogContentsPreviewExtraDataL2":{"required":["cursor","page_size","has_more_data"],"properties":{"cursor":{"type":"integer","description":""},"page_size":{"type":"integer","description":""},"has_more_data":{"type":"boolean","description":""}}},"LearnCatalogcontentInternalCatalogContentsPreviewExtraDataL3":{"required":["is_general_catalog"],"properties":{"is_general_catalog":{"type":"boolean","description":"True when the caller should access the general catalog (i.e. doesn't have neither any catalog nor any subscription license assigned)"}}},"LearnCatalogcontentInternalCatalogContentsPreviewLinks":{"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogContentsPreviewLast","description":"Link to the last page"}}},"LearnCatalogcontentInternalCatalogContentsPreviewSelf":{"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentInternalCatalogContentsPreviewGoto":{"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentInternalCatalogContentsPreviewFirst":{"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentInternalCatalogContentsPreviewLast":{"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentInternalCatalogsContentResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentInternalCatalogsContentData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of retrieved catalogs","items":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentItems"}}}},"LearnCatalogcontentInternalCatalogsContentItems":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentDataL2","description":"Catalog items data"}}},"LearnCatalogcontentInternalCatalogsContentDataL2":{"required":["sort","count","has_more_data","current_page","current_page_size","total_page_count","total_count","sub_items"],"properties":{"sort":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentSort"}},"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True when 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 number of the current page"},"current_page_size":{"type":"integer","description":"Current amount of items per page"},"total_page_count":{"type":"integer","description":"Total number of pages"},"total_count":{"type":"integer","description":"Total number of items"},"sub_items":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentSubItems"}}}},"LearnCatalogcontentInternalCatalogsContentSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"current sorting attribute"},"sort_dir":{"description":"current sorting direction","enum":["asc","desc"],"type":"string"}}},"LearnCatalogcontentInternalCatalogsContentSubItems":{"required":["item_id","item_type","item_code","item_name","item_slug","item_create_date","item_policy","item_can_enroll","is_opened","course_type","item_thumbnail","item_price","price_status","access_status"],"properties":{"item_id":{"type":"string","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_type_int":{"type":"string","description":""},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_slug":{"type":"string","description":"Item slug"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"string","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnCatalogcontentInternalCatalogsContentMultiLanguages"}},"item_create_date":{"type":"string","description":"Item creation date"},"number_of_courses":{"type":"string","description":"Number of courses (only available for Learning plans, otherwise NULL will be returned)"},"item_date_end":{"type":"string","description":"Item date end (only available for Courses, otherwise NULL will be returned)"},"item_visibility":{"type":"string","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"string","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"string","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free)"},"is_opened":{"type":"string","description":"Is course opened for subsription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"course_type":{"type":"string","description":"Course type (learning_plan for Learning plans)"},"duration":{"type":"string","description":"Item duration"},"waiting":{"type":"boolean","description":""},"item_rating":{"type":"integer","description":"Item rating (only available for Courses, otherwise NULL will be returned)"},"partner_fields":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentPartnerFields","description":"Additional fields related to the associated partner"},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"item_price":{"type":"string","description":"Item price"},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"},"prices":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentPrices","description":"The object that contains the course prices"},"access_status":{"type":"integer","description":"1 - enabled, 2 - disabled, 3 - expired, NULL - n/a (for Learning plans)"},"course_user_status":{"type":"string","description":""},"is_affiliate":{"type":"boolean","description":""},"is_user_subscribed":{"type":"integer","description":""},"is_user_enrolled":{"type":"string","description":""},"is_new":{"type":"boolean","description":""},"total_duration":{"type":"integer","description":"Total duration of courses in LP"},"item_ecommerce":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentItemEcommerce","description":"The item ecommerce pricing system"},"quick_course_launch":{"type":"boolean","description":"Whether the course quick enrollment is active."}}},"LearnCatalogcontentInternalCatalogsContentMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnCatalogcontentInternalCatalogsContentPartnerFields":{},"LearnCatalogcontentInternalCatalogsContentPrices":{"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."}}},"LearnCatalogcontentInternalCatalogsContentItemEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The item price from the external pricing system"},"discounted_price":{"type":"string","description":"The item discounted price from the external pricing system"},"currency":{"type":"string","description":"The item currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The item currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The item currency from the external pricing system"}}},"LearnCatalogcontentInternalCatalogsContentLinks":{"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentInternalCatalogsContentLast","description":"Link to the last page"}}},"LearnCatalogcontentInternalCatalogsContentSelf":{"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentInternalCatalogsContentGoto":{"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentInternalCatalogsContentFirst":{"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentInternalCatalogsContentLast":{"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentInternalGeneralCatalogContentResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalGeneralCatalogContentData","description":"Catalog items data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCatalogcontentInternalGeneralCatalogContentData":{"required":["count","has_more_data","current_page","current_page_size","total_page_count","total_count","items","extra_data"],"properties":{"count":{"type":"integer","description":"Total number of items returned"},"has_more_data":{"type":"boolean","description":"True when 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":"Size of the returned page"},"total_page_count":{"type":"integer","description":"Total number of pages"},"total_count":{"type":"integer","description":"Total number of items"},"items":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCatalogcontentInternalGeneralCatalogContentItems"}},"extra_data":{"$ref":"#/definitions/LearnCatalogcontentInternalGeneralCatalogContentExtraData","description":"Catalog data"}}},"LearnCatalogcontentInternalGeneralCatalogContentItems":{"required":["item_id","item_type","item_code","item_name","item_slug","item_create_date","item_policy","item_can_enroll","is_opened","course_type","item_thumbnail","item_price","price_status","access_status"],"properties":{"item_id":{"type":"string","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_type_int":{"type":"string","description":""},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_slug":{"type":"string","description":"Item slug"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"string","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnCatalogcontentInternalGeneralCatalogContentMultiLanguages"}},"item_create_date":{"type":"string","description":"Item creation date"},"number_of_courses":{"type":"string","description":"Number of courses (only available for Learning plans, otherwise NULL will be returned)"},"item_date_end":{"type":"string","description":"Item date end (only available for Courses, otherwise NULL will be returned)"},"item_visibility":{"type":"string","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"string","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"string","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free)"},"is_opened":{"type":"string","description":"Is course opened for subscription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"course_type":{"type":"string","description":"Course type (learning_plan for Learning plans)"},"duration":{"type":"string","description":"Item duration"},"waiting":{"type":"boolean","description":""},"item_rating":{"type":"integer","description":"Item rating (only available for Courses, otherwise NULL will be returned)"},"partner_fields":{"$ref":"#/definitions/LearnCatalogcontentInternalGeneralCatalogContentPartnerFields","description":"Additional fields related to the associated partner"},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"item_price":{"type":"string","description":"Item price"},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"},"prices":{"$ref":"#/definitions/LearnCatalogcontentInternalGeneralCatalogContentPrices","description":"The object that contains the course prices"},"access_status":{"type":"integer","description":"1 - enabled, 2 - disabled, 3 - expired, NULL - n/a (for Learning plans)"},"course_user_status":{"type":"string","description":""},"is_affiliate":{"type":"boolean","description":""},"is_user_subscribed":{"type":"integer","description":""},"is_user_enrolled":{"type":"string","description":""},"is_new":{"type":"boolean","description":""},"total_duration":{"type":"integer","description":"Total duration of courses in LP"},"item_ecommerce":{"$ref":"#/definitions/LearnCatalogcontentInternalGeneralCatalogContentItemEcommerce","description":"The item ecommerce pricing system"},"quick_course_launch":{"type":"boolean","description":"Whether the course quick enrollment is active."}}},"LearnCatalogcontentInternalGeneralCatalogContentMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnCatalogcontentInternalGeneralCatalogContentPartnerFields":{},"LearnCatalogcontentInternalGeneralCatalogContentPrices":{"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."}}},"LearnCatalogcontentInternalGeneralCatalogContentItemEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The item price from the external pricing system"},"discounted_price":{"type":"string","description":"The item discounted price from the external pricing system"},"currency":{"type":"string","description":"The item currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The item currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The item currency from the external pricing system"}}},"LearnCatalogcontentInternalGeneralCatalogContentExtraData":{"required":["list_type","sort_attr","sort_dir"],"properties":{"list_type":{"type":"integer","description":""},"sort_attr":{"type":"string","description":"current sorting attribute"},"sort_dir":{"description":"current sorting direction","enum":["asc","desc"],"type":"string"}}},"LearnCatalogcontentPublicCalendarGeneralCatalogsContentResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarGeneralCatalogsContentData","description":"List of all retrieved courses"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarGeneralCatalogsContentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentPublicCalendarGeneralCatalogsContentData":{"required":["items"],"properties":{"items":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarGeneralCatalogsContentItems","description":"Array of course info objects"}}},"LearnCatalogcontentPublicCalendarGeneralCatalogsContentItems":{"required":["course_id","course_type","course_name","course_slug","course_description","event_date_start","event_date_end","all_day","location","is_paid","event_name"],"properties":{"course_id":{"type":"integer","description":"ID of the course"},"course_type":{"type":"string","description":"Course type. Options: "classroom""},"course_name":{"type":"string","description":"Course name"},"course_slug":{"type":"string","description":"The Slug name (name-with-dashes) of the course"},"course_description":{"type":"string","description":"Course description"},"event_date_start":{"type":"string","description":"The day and time of begin of the event"},"event_date_end":{"type":"string","description":"The day and time of end of the event"},"all_day":{"type":"boolean","description":"Is it takes all day long. Options: 1 - true, 0 - false"},"location":{"type":"string","description":"Session location"},"is_paid":{"type":"boolean","description":"True when a course is on sale"},"event_name":{"type":"string","description":"Name of session on given date"},"physical_location":{"type":"string","description":"Physical event location"},"event_location_type":{"description":"Event location type.","enum":["Flexible","Onsite","Online training"],"type":"string"},"timezone":{"type":"string","description":"Timezone of the event"}}},"LearnCatalogcontentPublicCalendarGeneralCatalogsContentLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarGeneralCatalogsContentSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarGeneralCatalogsContentGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarGeneralCatalogsContentFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarGeneralCatalogsContentLast","description":"Link to the last page"}}},"LearnCatalogcontentPublicCalendarGeneralCatalogsContentSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentPublicCalendarGeneralCatalogsContentGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentPublicCalendarGeneralCatalogsContentFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentPublicCalendarGeneralCatalogsContentLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentPublicCalendarCatalogsContentResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarCatalogsContentData","description":"List of all retrieved courses"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarCatalogsContentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentPublicCalendarCatalogsContentData":{"required":["items"],"properties":{"items":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarCatalogsContentItems","description":"Array of course info objects"}}},"LearnCatalogcontentPublicCalendarCatalogsContentItems":{"required":["course_id","course_type","course_name","course_slug","course_description","event_date_start","event_date_end","all_day","location","is_paid","event_name"],"properties":{"course_id":{"type":"integer","description":"ID of the course"},"course_type":{"type":"string","description":"Course type. Options: "classroom""},"course_name":{"type":"string","description":"Course name"},"course_slug":{"type":"string","description":"The Slug name (name-with-dashes) of the course"},"course_description":{"type":"string","description":"Course description"},"event_date_start":{"type":"string","description":"The day and time of begin of the event"},"event_date_end":{"type":"string","description":"The day and time of end of the event"},"all_day":{"type":"boolean","description":"Is it takes all day long. Options: 1 - true, 0 - false"},"location":{"type":"string","description":"Session location"},"is_paid":{"type":"boolean","description":"True when a course is on sale"},"event_name":{"type":"string","description":"Name of session on given date"},"physical_location":{"type":"string","description":"Physical event location"},"event_location_type":{"description":"Event location type.","enum":["Flexible","Onsite","Online training"],"type":"string"},"timezone":{"type":"string","description":"Timezone of the event"}}},"LearnCatalogcontentPublicCalendarCatalogsContentLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarCatalogsContentSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarCatalogsContentGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarCatalogsContentFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentPublicCalendarCatalogsContentLast","description":"Link to the last page"}}},"LearnCatalogcontentPublicCalendarCatalogsContentSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentPublicCalendarCatalogsContentGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentPublicCalendarCatalogsContentFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentPublicCalendarCatalogsContentLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogcontentInternalCalendarGeneralCatalogsContentResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarGeneralCatalogsContentData","description":"List of all retrieved courses"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarGeneralCatalogsContentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogcontentInternalCalendarGeneralCatalogsContentData":{"required":["items"],"properties":{"items":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarGeneralCatalogsContentItems","description":"Array of course info objects"}}},"LearnCatalogcontentInternalCalendarGeneralCatalogsContentItems":{"required":["course_id","course_type","course_name","course_slug","course_description","event_date_start","event_date_end","all_day","location","is_paid","event_name"],"properties":{"course_id":{"type":"integer","description":"ID of the course"},"course_type":{"type":"string","description":"Course type. Options: "classroom""},"course_name":{"type":"string","description":"Course name"},"course_slug":{"type":"string","description":"The Slug name (name-with-dashes) of the course"},"course_description":{"type":"string","description":"Course description"},"event_date_start":{"type":"string","description":"The day and time of begin of the event"},"event_date_end":{"type":"string","description":"The day and time of end of the event"},"all_day":{"type":"boolean","description":"Is it takes all day long. Options: 1 - true, 0 - false"},"location":{"type":"string","description":"Session location"},"is_paid":{"type":"boolean","description":"True when a course is on sale"},"event_name":{"type":"string","description":"Name of session on given date"},"physical_location":{"type":"string","description":"Physical event location"},"event_location_type":{"description":"Event location type.","enum":["Flexible","Onsite","Online training"],"type":"string"},"timezone":{"type":"string","description":"Timezone of the event"}}},"LearnCatalogcontentInternalCalendarGeneralCatalogsContentLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarGeneralCatalogsContentSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarGeneralCatalogsContentGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarGeneralCatalogsContentFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogcontentInternalCalendarGeneralCatalogsContentLast","description":"Link to the last page"}}},"LearnCatalogcontentInternalCalendarGeneralCatalogsContentSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogcontentInternalCalendarGeneralCatalogsContentGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogcontentInternalCalendarGeneralCatalogsContentFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogcontentInternalCalendarGeneralCatalogsContentLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueFiltersResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogueFiltersData","description":"List of all retrieved categories"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueFiltersLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueFiltersData":{"required":["filters"],"properties":{"filters":{"type":"array","description":"Array of filters","items":{"$ref":"#/definitions/LearnCatalogueFiltersFilters"}}}},"LearnCatalogueFiltersFilters":{"required":["title","type","filter_code","items"],"properties":{"title":{"type":"string","description":"Filter name"},"type":{"type":"string","description":"Filter type"},"filter_code":{"type":"string","description":"Filter code"},"items":{"type":"array","description":"Filter items","items":{"$ref":"#/definitions/LearnCatalogueFiltersItems"}}}},"LearnCatalogueFiltersItems":{"required":["name","value"],"properties":{"name":{"type":"string","description":"Item name"},"value":{"type":"string","description":"Item value"}}},"LearnCatalogueFiltersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueFiltersSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueFiltersGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueFiltersFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueFiltersLast","description":"Link to the last page"}}},"LearnCatalogueFiltersSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueFiltersGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueFiltersFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueFiltersLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueInternalFiltersResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogueInternalFiltersData","description":"List of all retrieved categories"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueInternalFiltersLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueInternalFiltersData":{"required":["filters"],"properties":{"filters":{"type":"array","description":"Array of filters","items":{"$ref":"#/definitions/LearnCatalogueInternalFiltersFilters"}}}},"LearnCatalogueInternalFiltersFilters":{"required":["title","type","filter_code","items"],"properties":{"title":{"type":"string","description":"Filter name"},"type":{"type":"string","description":"Filter type"},"filter_code":{"type":"string","description":"Filter code"},"items":{"type":"array","description":"Filter items","items":{"$ref":"#/definitions/LearnCatalogueInternalFiltersItems"}}}},"LearnCatalogueInternalFiltersItems":{"required":["name","value"],"properties":{"name":{"type":"string","description":"Item name"},"value":{"type":"string","description":"Item value"}}},"LearnCatalogueInternalFiltersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueInternalFiltersSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueInternalFiltersGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueInternalFiltersFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueInternalFiltersLast","description":"Link to the last page"}}},"LearnCatalogueInternalFiltersSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueInternalFiltersGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueInternalFiltersFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueInternalFiltersLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueWebpagesResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogueWebpagesData","description":"List of all retrieved pages"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueWebpagesLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueWebpagesData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of webpages objects","items":{"$ref":"#/definitions/LearnCatalogueWebpagesItems"}}}},"LearnCatalogueWebpagesItems":{"required":["id","title","content"],"properties":{"id":{"type":"string","description":"The internal ID of the webpage"},"title":{"type":"string","description":"The localized title of the webpage"},"content":{"type":"string","description":"Localized HTML content of the webpage"}}},"LearnCatalogueWebpagesLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueWebpagesSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueWebpagesGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueWebpagesFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueWebpagesLast","description":"Link to the last page"}}},"LearnCatalogueWebpagesSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueWebpagesGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueWebpagesFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueWebpagesLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueBatchImportSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array containing objects of values to be imported","items":{"$ref":"#/definitions/LearnCatalogueBatchImportItems"}}}},"LearnCatalogueBatchImportItems":{"required":["code","name"],"properties":{"code":{"type":"string","description":"The code of the catalog to create"},"name":{"type":"string","description":"The name of the catalog"},"description":{"type":"string","description":"An optional HTML description of the catalog"}}},"LearnCatalogueBatchImportResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnCatalogueBatchImportData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueBatchImportLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueBatchImportData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Message if there were any errors"}}},"LearnCatalogueBatchImportLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueBatchImportSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueBatchImportGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueBatchImportFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueBatchImportLast","description":"Link to the last page"}}},"LearnCatalogueBatchImportSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueBatchImportGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueBatchImportFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueBatchImportLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueBatchItemsSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array containing objects of values to be imported","items":{"$ref":"#/definitions/LearnCatalogueBatchItemsItems"}}}},"LearnCatalogueBatchItemsItems":{"required":["catalog_code","item_code","item_type"],"properties":{"catalog_code":{"type":"string","description":"The code of the catalogue that this item belongs to"},"item_code":{"type":"string","description":"The code of the item which we want to subscribe"},"item_type":{"description":"It can be Course or Learning Plan, possible values: "course", "learning_plan"","enum":["course","learning_plan"],"type":"string"}}},"LearnCatalogueBatchItemsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnCatalogueBatchItemsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueBatchItemsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueBatchItemsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Message if there were any errors"}}},"LearnCatalogueBatchItemsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueBatchItemsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueBatchItemsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueBatchItemsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueBatchItemsLast","description":"Link to the last page"}}},"LearnCatalogueBatchItemsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueBatchItemsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueBatchItemsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueBatchItemsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueBatchVisibilitySchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array containing objects of values to be imported","items":{"$ref":"#/definitions/LearnCatalogueBatchVisibilityItems"}}}},"LearnCatalogueBatchVisibilityItems":{"required":["catalog_code","entity_code","entity_type"],"properties":{"catalog_code":{"type":"string","description":"The code of the catalogue that visibility must be set for"},"entity_code":{"type":"string","description":"The unique identifier of the entity: for "user" type contains the username, for "group" contains the group name, for "orgchart" contains the branch code,"},"entity_type":{"description":"The type of entity to set visibility for; possible values: "user", "orgchart", "group"","enum":["user","orgchart","group"],"type":"string"},"include_descendants":{"type":"boolean","description":"Available only for "orgchart" type entities; it contains whether or not to include descendant branches as well."}}},"LearnCatalogueBatchVisibilityResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnCatalogueBatchVisibilityData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueBatchVisibilityLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueBatchVisibilityData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Message if there were any errors"}}},"LearnCatalogueBatchVisibilityLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueBatchVisibilitySelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueBatchVisibilityGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueBatchVisibilityFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueBatchVisibilityLast","description":"Link to the last page"}}},"LearnCatalogueBatchVisibilitySelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueBatchVisibilityGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueBatchVisibilityFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueBatchVisibilityLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueAddCourseToCatalogResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogueAddCourseToCatalogData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueAddCourseToCatalogLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueAddCourseToCatalogData":{"properties":{"success":{"type":"boolean","description":"true if the operation succeeded"}}},"LearnCatalogueAddCourseToCatalogLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueAddCourseToCatalogSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueAddCourseToCatalogGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueAddCourseToCatalogFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueAddCourseToCatalogLast","description":"Link to the last page"}}},"LearnCatalogueAddCourseToCatalogSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueAddCourseToCatalogGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueAddCourseToCatalogFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueAddCourseToCatalogLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueDeleteCourseFromCatalogResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogueDeleteCourseFromCatalogData","description":"Response array"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueDeleteCourseFromCatalogLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueDeleteCourseFromCatalogData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"true if the operation succeeded"}}},"LearnCatalogueDeleteCourseFromCatalogLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueDeleteCourseFromCatalogSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueDeleteCourseFromCatalogGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueDeleteCourseFromCatalogFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueDeleteCourseFromCatalogLast","description":"Link to the last page"}}},"LearnCatalogueDeleteCourseFromCatalogSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueDeleteCourseFromCatalogGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueDeleteCourseFromCatalogFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueDeleteCourseFromCatalogLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueBatchAddCoursesToCatalogsSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"List of courses to be imported into catalog","items":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsItems"}}}},"LearnCatalogueBatchAddCoursesToCatalogsItems":{"required":["course_id","catalog_id"],"properties":{"course_id":{"type":"integer","description":"The ID of the course"},"catalog_id":{"type":"integer","description":"The ID of the catalog used to specifies in which catalog you want to add the courses"},"batch_item_id":{"type":"string","description":"client-defined identifier for the single batch item. It will be returned in the output as it is"}}},"LearnCatalogueBatchAddCoursesToCatalogsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCatalogueBatchAddCoursesToCatalogsData":{"required":["row_index","success","course_id","catalog_id"],"properties":{"row_index":{"type":"integer","description":"Import ID for the current record"},"success":{"type":"boolean","description":"Could the record be properly imported?"},"message":{"type":"string","description":"Optional message to the client"},"course_id":{"type":"integer","description":"The ID of the assigned course"},"catalog_id":{"type":"integer","description":"The ID of the target catalog for the course"},"batch_item_id":{"type":"string","description":"identifier for the single batch item, specified in the input"}}},"LearnCatalogueBatchAddCoursesToCatalogsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCatalogueBatchAddCoursesToCatalogsLast","description":"Link to the last page"}}},"LearnCatalogueBatchAddCoursesToCatalogsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCatalogueBatchAddCoursesToCatalogsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCatalogueBatchAddCoursesToCatalogsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCatalogueBatchAddCoursesToCatalogsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCatalogueAdvancedFiltersResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersData","description":"List of all retrieved categories"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to pages","items":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersLinks"}}}},"LearnCatalogueAdvancedFiltersData":{"required":["fiters","classroom_fiters"],"properties":{"fiters":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersFiters","description":"Object of category elements"},"classroom_fiters":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersClassroomFiters","description":"Object of category elements"}}},"LearnCatalogueAdvancedFiltersFiters":{"required":["code","title","type","params"],"properties":{"code":{"type":"string","description":"The code of the filter"},"title":{"type":"string","description":"The title of the filter"},"hidden":{"type":"boolean","description":"Is the filter visible"},"type":{"type":"string","description":"The type of the filter"},"params":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersParams","description":"Object of possible values of the filter"}}},"LearnCatalogueAdvancedFiltersParams":{"properties":{"options":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersOptions","description":"Possible options for dropdowns and radio filters"}}},"LearnCatalogueAdvancedFiltersOptions":{"required":["label","key"],"properties":{"label":{"type":"string","description":"The label of the option"},"key":{"type":"string","description":"The key of the option"},"placeholder":{"type":"string","description":"The placeholder of the filter"}}},"LearnCatalogueAdvancedFiltersClassroomFiters":{"required":["code","title","type","params"],"properties":{"code":{"type":"string","description":"The code of the filter"},"title":{"type":"string","description":"The title of the filter"},"hidden":{"type":"boolean","description":"Is the filter visible"},"type":{"type":"string","description":"The type of the filter"},"params":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersParamsL2","description":"Object of possible values of the filter"}}},"LearnCatalogueAdvancedFiltersParamsL2":{"properties":{"options":{"$ref":"#/definitions/LearnCatalogueAdvancedFiltersOptionsL2","description":"Possible options for dropdowns and radio filters"}}},"LearnCatalogueAdvancedFiltersOptionsL2":{"required":["label","key"],"properties":{"label":{"type":"string","description":"The label of the option"},"key":{"type":"string","description":"The key of the option"},"placeholder":{"type":"string","description":"The placeholder of the filter"}}},"LearnCatalogueAdvancedFiltersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"type":"integer","description":"Link to the current page"},"goto":{"type":"string","description":"Go to a specified page number"},"first":{"type":"string","description":"Link to the first page"},"last":{"type":"string","description":"Link to the last page"}}},"LearnCategoriesIndexResponse":{"required":["data","version","extra_data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCategoriesIndexData","description":"List of all retrieved categories"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/LearnCategoriesIndexExtraData","description":"Extra information"},"_links":{"$ref":"#/definitions/LearnCategoriesIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS. Due to the specifics of the programming language, this attribute can be returned as empty array when there is no pagination."}}},"LearnCategoriesIndexData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of category elements","items":{"$ref":"#/definitions/LearnCategoriesIndexItems"}},"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. The attribute value can be null."},"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/LearnCategoriesIndexSort"}}}},"LearnCategoriesIndexItems":{"required":["id","code","title","title_parent","has_child","lev","iLeft","iRight"],"properties":{"id":{"type":"integer","description":"ID of the category"},"code":{"type":"string","description":"Code of the category. It can be also an empty string."},"title":{"type":"string","description":"Translated name of the category"},"title_parent":{"type":"string","description":"Translated name of the parent of current category"},"has_child":{"type":"boolean","description":"If the category has child categories"},"lev":{"type":"integer","description":"Selected level of the category"},"iLeft":{"type":"integer","description":"Scope from the left border of the category"},"iRight":{"type":"integer","description":"Scope to the right border of the category"},"counter":{"type":"string","description":"Sums sub category courses for every category that has count 0 to determine if the category is really empty. Visible when for_catalog_filter = 1. Can be null."},"counter2":{"type":"string","description":"Sums sub category learning plans for every category that has count 0 to determine if the category is really empty. Visible when for_catalog_filter = 1. Can be null."},"icon":{"type":"string","description":"May contain an icon path"},"can_manage":{"type":"boolean","description":"Always true for SA. For PU and SPU true if at least one of its parents is assigned with descendants or if itself is assigned with or without descendants, false otherwise. Not returned for NU"},"can_manage_all_children":{"type":"boolean","description":"true if current branch or any ancestor of it is assigned to SPU with descendants, false otherwise and false if branch has not any child. Always true for SA. Not returned for NU"}}},"LearnCategoriesIndexSort":{"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"}}},"LearnCategoriesIndexExtraData":{"required":["id","title","title_parent","id_parent","lev","iLeft","iRight","is_root","root_node_id"],"properties":{"id":{"type":"integer","description":"Root node or the requested category ID"},"title":{"type":"string","description":"Root node or the requested category title"},"title_parent":{"type":"string","description":"Root node or the parent node of the requested category"},"id_parent":{"type":"integer","description":"ID of the parent category if node_id is requested."},"lev":{"type":"integer","description":"Level of the requested category"},"iLeft":{"type":"integer","description":"Left index of the requested category"},"iRight":{"type":"integer","description":"Right index of the requested category"},"is_root":{"type":"boolean","description":"Flag if the requested category is the root node"},"root_node_id":{"type":"number","description":"the ID of the root node, disregarding which node we request information from"},"can_manage":{"type":"boolean","description":"Always true for SA. true for PU or SPU if the root branch is assigned to them. false otherwise."}}},"LearnCategoriesIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCategoriesIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCategoriesIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCategoriesIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCategoriesIndexLast","description":"Link to the last page"}}},"LearnCategoriesIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCategoriesIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCategoriesIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCategoriesIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCategoriesViewChildsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCategoriesViewChildsData","description":"List of the child categories"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCategoriesViewChildsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCategoriesViewChildsData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of category elements","items":{"$ref":"#/definitions/LearnCategoriesViewChildsItems"}}}},"LearnCategoriesViewChildsItems":{"required":["idCategory","code","category_name","has_child"],"properties":{"idCategory":{"type":"integer","description":"ID of the category"},"code":{"type":"string","description":"Code of the category"},"category_name":{"type":"string","description":"Translated name of the category"},"has_child":{"type":"integer","description":"If the category has child categories"}}},"LearnCategoriesViewChildsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCategoriesViewChildsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCategoriesViewChildsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCategoriesViewChildsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCategoriesViewChildsLast","description":"Link to the last page"}}},"LearnCategoriesViewChildsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCategoriesViewChildsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCategoriesViewChildsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCategoriesViewChildsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCertificationIndexResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCertificationIndexData","description":"List of all retrieved certifications"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCertificationIndexData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of certification info objects","items":{"$ref":"#/definitions/LearnCertificationIndexItems"}}}},"LearnCertificationIndexItems":{"required":["id_cert","title","description","duration","allow_same_item","duration_unit","code"],"properties":{"id_cert":{"type":"integer","description":"ID of the certification"},"title":{"type":"string","description":"certification title"},"description":{"type":"string","description":"Certification description"},"duration":{"type":"string","description":"Certification duration"},"allow_same_item":{"type":"boolean","description":"whatever same items to be allowed to be used to retake the certification"},"duration_unit":{"type":"string","description":"the certification duration unit"},"code":{"type":"string","description":"Certification code"}}},"LearnCertificationBatchImportSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Associative array containing key/value pairs to be imported","items":{"$ref":"#/definitions/LearnCertificationBatchImportItems"}},"options":{"$ref":"#/definitions/LearnCertificationBatchImportOptions","description":"Object containing additional options"}}},"LearnCertificationBatchImportItems":{"required":["username","certification_code","issue_date","always_valid","type"],"properties":{"username":{"type":"string","description":"The unique username for a user"},"certification_code":{"type":"string","description":"The code of the certification"},"issue_date":{"type":"string","format":"date","description":"The issuing date of the certification"},"always_valid":{"type":"boolean","description":"Is this certification always valid (true), or is it expiring after some time (false)"},"expiration_date":{"type":"string","format":"date","description":"The expiration date of the certification (if it is not always valid)"},"code":{"type":"string","description":"The code of the course or learning plan, associated with the certification (this parameter is required if the 'type' parameter is equal to 'course' or 'learning_plan')"},"type":{"description":"The association type of the certification","enum":["course","learning_plan","external_training","manual"],"type":"string"}}},"LearnCertificationBatchImportOptions":{"required":["update_certifications"],"properties":{"update_certifications":{"type":"boolean","description":"Should an already existing record be updated or not"}}},"LearnCertificationBatchImportResponse":{"required":["response","version"],"properties":{"response":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnCertificationBatchImportResponseL2"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCertificationBatchImportResponseL2":{"required":["row_index","success"],"properties":{"row_index":{"type":"integer","description":"The index of the certification record in the input parameters array"},"success":{"type":"boolean","description":"Was the tracking data for the certification, properly imported"},"message":{"type":"string","description":"Optional error message, if the operation was not successful"}}},"LearnCertificationImporterFieldsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCertificationImporterFieldsData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCertificationImporterFieldsData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/LearnCertificationImporterFieldsFields"}}}},"LearnCertificationImporterFieldsFields":{},"LearnChanneldashboardViewResponse":{"required":["data","version","version","version","extra_data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardViewData","description":"List of all retrieved items"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"type":"array","description":"Array with extra data","items":{"$ref":"#/definitions/LearnChanneldashboardViewExtraData"}},"_links":{"$ref":"#/definitions/LearnChanneldashboardViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnChanneldashboardViewData":{"properties":{"items":{"type":"array","description":"Array of channel assets","items":{"$ref":"#/definitions/LearnChanneldashboardViewItems"}},"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/LearnChanneldashboardViewSort"}}},"required":["count","has_more_data","current_page","current_page_size"]},"LearnChanneldashboardViewItems":{"required":["id","type_id","image_url","title","rating_option","created","language_label","is_asset_downloadable","content_type"],"properties":{"id":{"type":"integer","description":"ID of the item"},"type_id":{"type":"string","description":"Possible values: my-course, my-lp, asset, playlist"},"uri":{"type":"string","description":"URI of the item. If the channel is My areas of improvement this item will not be present."},"link_url":{"type":"string","description":"URI of the external content item. This item will be present only for My areas of improvement channel items."},"image_url":{"type":"string","description":"Image of the item"},"title":{"type":"string","description":"Title of the item"},"rating_option":{"description":"Rating option for course assets","enum":["disabled","always","only_enrolled","only_completed"],"type":"string"},"created":{"type":"string","description":"The created date of the asset"},"language_label":{"type":"string","description":"Human readable language name"},"is_asset_downloadable":{"type":"boolean","description":"Whether the asset can be downloaded separately"},"content_type":{"type":"string","description":"Asset content type"},"description":{"type":"string","description":"Description of the item(for the external content only)"},"external_type":{"type":"string","description":"External content item type - i.e. 'link'"},"shared_asset_id":{"type":"integer","description":"User external content asset id"},"duration":{"type":"string","description":"Duration of the item. If the channel is My areas of improvement this item will not be present."},"rating":{"type":"string","description":"Rating of the item. If the channel is My areas of improvement this item will not be present."},"is_new":{"type":"boolean","description":"Status is new of the item. If the channel is My areas of improvement this item will not be present."},"hidden":{"type":"boolean","description":"Visibility of the item. If the channel is My areas of improvement this item will not be present."},"is_loading":{"type":"boolean","description":"If true, the asset is not visible and is still in converting"},"is_error":{"type":"boolean","description":"True if assets failed to upload or convert (only if owner is logged user)"},"actions":{"type":"array","description":"Actions of the item. If the channel is My areas of improvement this item will not be present.","items":{"$ref":"#/definitions/LearnChanneldashboardViewActions"}},"other_fields":{"type":"array","description":"Actions of the item. If the channel is My areas of improvement this object will not be present","items":{"$ref":"#/definitions/LearnChanneldashboardViewOtherFields"}},"owner":{"$ref":"#/definitions/LearnChanneldashboardViewOwner","description":"Return owner of asset. If the channel is My areas of improvement this object will not be present"},"inviter":{"$ref":"#/definitions/LearnChanneldashboardViewInviter","description":"Parameter returned only for the built-in invitations channel. Returns the inviter of the asset"},"outdated":{"$ref":"#/definitions/LearnChanneldashboardViewOutdated","description":"Mark as outdated information. If the channel is My areas of improvement this object will not be present"},"briefing":{"$ref":"#/definitions/LearnChanneldashboardViewBriefing","description":"The briefing information. This item will be returned only if the channel is My Areas Of Improvement."}}},"LearnChanneldashboardViewActions":{"required":["action_type","label","color","url"],"properties":{"action_type":{"type":"string","description":"Type of the item action"},"label":{"type":"string","description":"Label of the item action"},"color":{"type":"string","description":"Color of the item action"},"url":{"type":"string","description":"Url of the item action"}}},"LearnChanneldashboardViewOtherFields":{"properties":{"status_id":{"type":"string","description":"The user status identifier (i.e. "subscribed", "in_progress", "completed")"},"status_label":{"type":"string","description":"The localized status label to display"},"courses_count":{"type":"integer","description":"he number of courses in the learning plan"},"can_enter":{"type":"boolean","description":"Whether clicking on the item is allowed. Default = true"},"can_enter_reason":{"type":"string","description":"If can_enter is true, this contains the message to display in the tooltip when you click/tap on the lock overlay or on the "?" icon in the bottom right corner. Default = empty"},"expiration_date":{"type":"string","description":"The MYSQL UTC expiration date for this enrollment/course. It must be formatted to display the "15 days left" red message"},"language":{"type":"string","description":"The item language"},"language_code":{"type":"string","description":"item language code (e.g. "en", "es", "de" - available only for Courses, otherwise NULL will be returned)"},"level":{"type":"string","description":"The user level inside the course"},"type":{"type":"string","description":"The type of course. Possible values: elearning, classroom, learning_plan, 1 - video, 2 - document, 3 - spreadsheets, 4 - slides (powerpoint), 5 - PDF, 6 - simple text file, 7 - image, 10 - other, 11 - default other, 12 - audio file, 13 - archive file, 15 - links, 16 - google drive document, 17 - google drive spreadsheets, 18 - google drive slides (powerpoint), 20 - youtube video link, 21 - vimeo video link, 22 - wistia video link, 23 - shape video link"},"is_watched":{"type":"string","description":"Returns 'Done' if the asset was watched by the user and empty string if not"},"status":{"type":"string","description":"The asset status"},"is_private":{"type":"boolean","description":"Private asset or not"},"views":{"type":"integer","description":"how many times the asset was viewed"},"publish_date":{"type":"string","description":"Publication date of asset"},"assets_count":{"type":"integer","description":"The number of assets in the playlist"},"quick_course_launch":{"type":"boolean","description":"Whether the course quick enrollment is active."},"multi_languages":{"type":"array","description":"Only available for when type_id is 'my-course' when the multi-language feature is on.","items":{"$ref":"#/definitions/LearnChanneldashboardViewMultiLanguages"}}},"required":["language_code"]},"LearnChanneldashboardViewMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Browser code format of the course language"},"code":{"type":"string","description":"Code of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnChanneldashboardViewOwner":{"properties":{"id":{"type":"integer","description":"ID of the owner"},"uuid":{"type":"string","description":"UUID of the owner"},"short_name":{"type":"string","description":"Short name of the owner"},"full_name":{"type":"string","description":"Full name of the owner"},"avatar":{"type":"string","description":"Avatar of the owner"},"is_expert":{"type":"boolean","description":"Is this user is Expert to channel"}},"required":["uuid"]},"LearnChanneldashboardViewInviter":{"properties":{"id":{"type":"integer","description":"ID of the inviter"},"short_name":{"type":"string","description":"Short name of the inviter"},"full_name":{"type":"string","description":"Full name of the inviter"},"avatar":{"type":"string","description":"Avatar of the inviter"}}},"LearnChanneldashboardViewOutdated":{"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"}}},"LearnChanneldashboardViewBriefing":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"The briefing id."},"name":{"type":"string","description":"The briefing name."}}},"LearnChanneldashboardViewSort":{"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"}}},"LearnChanneldashboardViewExtraData":{"required":["experts_count","user","channel"],"properties":{"experts_count":{"type":"integer","description":"Total count of channel experts"},"user":{"type":"array","description":"Array of user information","items":{"type":"null"}},"channel":{"$ref":"#/definitions/LearnChanneldashboardViewChannel","description":"Array of channel information"}}},"LearnChanneldashboardViewChannel":{"required":["id","is_enabled","created","name","description","icon"],"properties":{"id":{"type":"integer","description":"ID of the channel"},"is_enabled":{"type":"boolean","description":"Channel enabled status"},"is_followed":{"type":"boolean","description":"If the logged user follow this channel or not"},"followers_count":{"type":"integer","description":"The number of users that follow this channel"},"notification":{"description":"The notification type for the followed channel","enum":["none","push","digest"],"type":"string"},"created":{"type":"string","description":"Channel date created"},"name":{"type":"string","description":"Channel name"},"description":{"type":"string","description":"Channel description"},"skills_target_filter":{"description":"Filter content based on the skills target, for ai-based channels only","enum":["all","with_target","without_target"],"type":"string"},"icon":{"type":"array","description":"Channel icon details","items":{"$ref":"#/definitions/LearnChanneldashboardViewIcon"}}}},"LearnChanneldashboardViewIcon":{"required":["font","color","background"],"properties":{"font":{"type":"string","description":"Channel icon font"},"color":{"type":"string","description":"Channel icon color"},"background":{"type":"string","description":"Channel icon background"}}},"LearnChanneldashboardViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnChanneldashboardViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnChanneldashboardViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnChanneldashboardViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnChanneldashboardViewLast","description":"Link to the last page"}}},"LearnChanneldashboardViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnChanneldashboardViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnChanneldashboardViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnChanneldashboardViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnChanneldashboardListResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardListData","description":"List of all retrieved questions"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnChanneldashboardListLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnChanneldashboardListData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of questions","items":{"$ref":"#/definitions/LearnChanneldashboardListItems"}}}},"LearnChanneldashboardListItems":{"required":["id","is_enabled","created","name","description","icon","count","has_more_data","current_page","current_page_size"],"properties":{"id":{"type":"integer","description":"ID of the channel"},"is_enabled":{"type":"boolean","description":"Channel enabled status"},"created":{"type":"string","description":"Channel date created"},"name":{"type":"string","description":"Channel name"},"description":{"type":"string","description":"Channel description"},"predefined_uid":{"type":"string","description":"Channel predefined unique identifier"},"sort_items":{"type":"string","description":"Channel default items sorting"},"icon":{"$ref":"#/definitions/LearnChanneldashboardListIcon","description":"Channel icon details"},"is_followed":{"type":"boolean","description":"If the logged user follow this channel or not. Applicable only for custom channels"},"notification":{"description":"The notification type for the followed channel","enum":["none","push","digest"],"type":"string"},"sub_items":{"type":"array","description":"Array of channel items","items":{"$ref":"#/definitions/LearnChanneldashboardListSubItems"}},"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 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"}}},"LearnChanneldashboardListIcon":{"required":["font","color","background"],"properties":{"font":{"type":"string","description":"Channel icon font"},"color":{"type":"string","description":"Channel icon color"},"background":{"type":"string","description":"Channel icon background"}}},"LearnChanneldashboardListSubItems":{"required":["id","type_id","uri","image_url","title","is_new","is_asset_downloadable","actions","other_fields"],"properties":{"id":{"type":"integer","description":"ID of the item"},"type_id":{"type":"string","description":"Possible values: my-course, my-lp, asset, playlist"},"uri":{"type":"string","description":"URI of the item"},"image_url":{"type":"string","description":"Image of the item"},"title":{"type":"string","description":"Title of the item"},"description":{"type":"string","description":"Description of the item(for the external content only)"},"external_type":{"type":"string","description":"External content item type - i.e. 'link'"},"shared_asset_id":{"type":"integer","description":"User external content asset id"},"duration":{"type":"string","description":"Duration of the item"},"rating_option":{"description":"Rating option","enum":["disabled","always","only_enrolled","only_completed"],"type":"string"},"rating":{"type":"string","description":"Rating of the item"},"is_new":{"type":"boolean","description":"Status is new of the item"},"created":{"type":"string","format":"date","description":"Date of creation (YYYY-MM-DD HH:MM:SS e.g "2015-06-30 12:00:00")"},"domain":{"type":"string","description":"Domain"},"link_url":{"type":"string","description":"Link URL"},"is_loading":{"type":"boolean","description":"If true, the asset is not visible and is still in converting"},"is_error":{"type":"boolean","description":"True if assets failed to upload or convert (only if owner is logged user)"},"language_label":{"type":"string","description":"The item language label"},"hidden":{"type":"boolean","description":"True if the asset is hidden"},"content_type":{"type":"string","description":"Content type of the item"},"is_asset_downloadable":{"type":"boolean","description":"Is asset downloadable field"},"actions":{"type":"array","description":"Actions of the item","items":{"$ref":"#/definitions/LearnChanneldashboardListActions"}},"other_fields":{"$ref":"#/definitions/LearnChanneldashboardListOtherFields","description":"Other fields of the item"},"outdated":{"$ref":"#/definitions/LearnChanneldashboardListOutdated","description":"Mark as outdated information"},"inviter":{"$ref":"#/definitions/LearnChanneldashboardListInviter","description":"Return the inviter"},"owner":{"$ref":"#/definitions/LearnChanneldashboardListOwner","description":"Return owner of answer object"}}},"LearnChanneldashboardListActions":{"required":["type","label","color","url"],"properties":{"type":{"type":"string","description":"Type of the item action"},"label":{"type":"string","description":"Label of the item action"},"color":{"type":"string","description":"Color of the item action"},"url":{"type":"string","description":"Url of the item action"}}},"LearnChanneldashboardListOtherFields":{"properties":{"status_id":{"type":"string","description":"The user status identifier (i.e. "enrolled", "in_progress", "completed")"},"status_label":{"type":"string","description":"The localized status label to display"},"courses_count":{"type":"integer","description":"The number of courses in the learning plan"},"can_enter":{"type":"boolean","description":"Whether clicking on the item is allowed. Default = true"},"can_enter_reason":{"type":"string","description":"If can_enter is true, this contains the message to display in the tooltip when you click/tap on the lock overlay or on the "?" icon in the bottom right corner. Default = empty"},"expiration_date":{"type":"string","description":"The MYSQL UTC expiration date for this enrollment/course. It must be formatted to display the "15 days left" red message"},"language":{"type":"string","description":"The item language"},"language_code":{"type":"string","description":"item language code (e.g. "en", "es", "de" - available only for Courses and Learningplans, otherwise NULL will be returned)"},"language_label":{"type":"string","description":"The item language label"},"level":{"type":"string","description":"The user level inside the course"},"level_label":{"type":"string","description":"The translated user level inside the course"},"type":{"type":"integer","description":"The type of course"},"is_watched":{"type":"string","description":"Whether or not the asset was watched by the user ("Done", "")"},"status":{"type":"string","description":"The asset status"},"is_private":{"type":"boolean","description":"Private asset or not"},"views":{"type":"integer","description":"how many times the asset was viewed"},"publish_date":{"type":"string","description":"Publication date of asset"},"assets_count":{"type":"integer","description":"The number of assets in the playlist"},"quick_course_launch":{"type":"boolean","description":"Whether the course quick enrollment is active."},"multi_languages":{"type":"array","description":"Only available for when type_id is 'my-course' when the multi-language feature is on.","items":{"$ref":"#/definitions/LearnChanneldashboardListMultiLanguages"}},"can_enter_reason_code":{"type":"string","description":"The reason code for the can_enter field."}},"required":["language_code"]},"LearnChanneldashboardListMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Browser code format of the course language"},"code":{"type":"string","description":"Code of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnChanneldashboardListOutdated":{"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"}}},"LearnChanneldashboardListInviter":{"properties":{"id":{"type":"integer","description":"ID of the inviter"},"short_name":{"type":"string","description":"Short name of the inviter"},"full_name":{"type":"string","description":"Full name of the inviter"},"avatar":{"type":"string","description":"Avatar of the inviter"}}},"LearnChanneldashboardListOwner":{"properties":{"id":{"type":"integer","description":"ID of the owner"},"uuid":{"type":"string","description":"UUID of the owner"},"short_name":{"type":"string","description":"Short name of the owner"},"full_name":{"type":"string","description":"Full name of the owner"},"avatar":{"type":"string","description":"Avatar of the owner"},"is_expert":{"type":"boolean","description":"Is this user is Expert to channel"}},"required":["uuid"]},"LearnChanneldashboardListLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnChanneldashboardListSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnChanneldashboardListGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnChanneldashboardListFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnChanneldashboardListLast","description":"Link to the last page"}}},"LearnChanneldashboardListSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnChanneldashboardListGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnChanneldashboardListFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnChanneldashboardListLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnChanneldashboardUnfollowSchema":{"type":"object","required":["channel_ids"],"properties":{"channel_ids":{"type":"array","description":"The array containing channel IDs","items":{"type":"integer"}}}},"LearnChanneldashboardUnfollowResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardUnfollowData","description":"Results of the Unfollow action"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/LearnChanneldashboardUnfollowLinks"}}}},"LearnChanneldashboardUnfollowData":{"required":["success","channel_ids"],"properties":{"success":{"type":"boolean","description":"True if the channel is unfollowed"},"channel_ids":{"type":"array","description":"List of processed channel IDs","items":{"type":"integer"}}}},"LearnChanneldashboardUnfollowLinks":{},"LearnChanneldashboardFollowSchema":{"type":"object","required":["channel_ids"],"properties":{"channel_ids":{"type":"array","description":"The array containing channel IDs","items":{"type":"integer"}},"notification":{"description":"The notification type for the followed channel. Default: none","enum":["none","push","digest"],"type":"string"}}},"LearnChanneldashboardFollowResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardFollowData","description":"The API result"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources.","items":{"$ref":"#/definitions/LearnChanneldashboardFollowLinks"}}}},"LearnChanneldashboardFollowData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of follow objects","items":{"$ref":"#/definitions/LearnChanneldashboardFollowItems"}}}},"LearnChanneldashboardFollowItems":{"required":["id","channel_id"],"properties":{"id":{"type":"integer","description":"The ID of the new follow object"},"channel_id":{"type":"integer","description":"The id of the followed channel"}}},"LearnChanneldashboardFollowLinks":{},"LearnChanneldashboardChangeFollowNotificationSchema":{"type":"object","required":["notification"],"properties":{"notification":{"description":"The notification type for the followed channel","enum":["none","push","digest"],"type":"string"}}},"LearnChanneldashboardChangeFollowNotificationResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardChangeFollowNotificationData","description":"The API result"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/LearnChanneldashboardChangeFollowNotificationLinks"}}}},"LearnChanneldashboardChangeFollowNotificationData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"TRUE if the request has been successful"}}},"LearnChanneldashboardChangeFollowNotificationLinks":{},"LearnChanneldashboardChannelExpertsResponse":{"required":["data","version","version","version","_links","version","extra_data","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsData","description":"List of all retrieved channel experts"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"},"extra_data":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsExtraData","description":"Array with extra data"}}},"LearnChanneldashboardChannelExpertsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of channel experts","items":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsItems"}},"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/LearnChanneldashboardChannelExpertsSort"}}}},"LearnChanneldashboardChannelExpertsItems":{"required":["user_id","uuid","avatar","name","initials","mail","username"],"properties":{"user_id":{"type":"integer","description":"ID of the expert"},"uuid":{"type":"string","description":"UUID of the expert"},"avatar":{"type":"string","description":"Avatar of the expert"},"name":{"type":"string","description":"Name of the expert"},"initials":{"type":"string","description":"Initials of the expert"},"mail":{"type":"string","description":"Email of the expert"},"username":{"type":"string","description":"Username username"}}},"LearnChanneldashboardChannelExpertsSort":{"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"}}},"LearnChanneldashboardChannelExpertsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnChanneldashboardChannelExpertsLast","description":"Link to the last page"}}},"LearnChanneldashboardChannelExpertsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnChanneldashboardChannelExpertsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnChanneldashboardChannelExpertsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnChanneldashboardChannelExpertsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnChanneldashboardChannelExpertsExtraData":{"required":["channel_name"],"properties":{"channel_name":{"type":"string","description":"Channel name"}}},"LearnChanneldashboardListUserContentPendingCountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardListUserContentPendingCountData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnChanneldashboardListUserContentPendingCountLinks","description":"Links to related resources"}}},"LearnChanneldashboardListUserContentPendingCountData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of content","items":{"$ref":"#/definitions/LearnChanneldashboardListUserContentPendingCountItems"}}}},"LearnChanneldashboardListUserContentPendingCountItems":{"required":["content_type","content_count"],"properties":{"content_type":{"description":"Type of content","enum":["asset","course"],"type":"string"},"content_count":{"type":"integer","description":"Number of pending content"}}},"LearnChanneldashboardListUserContentPendingCountLinks":{},"LearnChanneldashboardListUserContentCompletedCountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardListUserContentCompletedCountData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnChanneldashboardListUserContentCompletedCountLinks","description":"Links to related resources"}}},"LearnChanneldashboardListUserContentCompletedCountData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of content","items":{"$ref":"#/definitions/LearnChanneldashboardListUserContentCompletedCountItems"}}}},"LearnChanneldashboardListUserContentCompletedCountItems":{"required":["content_type","content_counts"],"properties":{"content_type":{"description":"Type of content","enum":["asset","course"],"type":"string"},"content_counts":{"type":"array","description":"Array of content counts grouped by year and month","items":{"$ref":"#/definitions/LearnChanneldashboardListUserContentCompletedCountContentCounts"}}}},"LearnChanneldashboardListUserContentCompletedCountContentCounts":{"required":["year","month","value"],"properties":{"year":{"type":"integer","description":"The year"},"month":{"type":"integer","description":"The month"},"value":{"type":"integer","description":"The number of completed content"}}},"LearnChanneldashboardListUserContentCompletedCountLinks":{},"LearnChanneldashboardListUserCoursesTimeSpentResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardListUserCoursesTimeSpentData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnChanneldashboardListUserCoursesTimeSpentLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnChanneldashboardListUserCoursesTimeSpentData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of content counts grouped by year and month","items":{"$ref":"#/definitions/LearnChanneldashboardListUserCoursesTimeSpentItems"}}}},"LearnChanneldashboardListUserCoursesTimeSpentItems":{"required":["year","month","value"],"properties":{"year":{"type":"integer","description":"The year"},"month":{"type":"integer","description":"The month"},"value":{"type":"integer","description":"The number of spent hours"}}},"LearnChanneldashboardListUserCoursesTimeSpentLinks":{},"LearnChanneldashboardListLatestUpdatesForUserResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardListLatestUpdatesForUserData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnChanneldashboardListLatestUpdatesForUserData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of skill updates","items":{"$ref":"#/definitions/LearnChanneldashboardListLatestUpdatesForUserItems"}}}},"LearnChanneldashboardListLatestUpdatesForUserItems":{"properties":{"manager":{"$ref":"#/definitions/LearnChanneldashboardListLatestUpdatesForUserManager","description":"Information about the manager"},"skill_code":{"type":"string","description":"Code of the skill"},"skill_name":{"type":"string","description":"Name of the skill"},"type":{"type":"string","description":"Type of the update. Possible values (suggest, evaluate, improve, suggested_content, new_content, best_performance)"},"expertise":{"type":"integer","description":"The level of evaluation for the skill, present only for type "evaluate""},"evaluation_id":{"type":"integer","description":"The ID of the manager evaluation, present only for type "suggest", "evaluate", "improve""},"active":{"type":"boolean","description":"Status of the evaluation, present only for type "suggest", "evaluate", "improve""},"count":{"type":"integer","description":"Number of content, used only for types suggested_content and new_content"},"date":{"type":"string","description":"Creation UTC date of record. The format is YYYY-MM-DD"}},"required":["type","date"]},"LearnChanneldashboardListLatestUpdatesForUserManager":{"required":["username","firstname","lastname","avatar"],"properties":{"username":{"type":"string","description":"The username of the manager"},"firstname":{"type":"string","description":"The firstname of the manager"},"lastname":{"type":"string","description":"The lastname of the manager"},"avatar":{"type":"string","description":"The URL of the avatar of the manager"}}},"LearnChanneldashboardListAssetsCanBeSuggestedToUserResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnChanneldashboardListAssetsCanBeSuggestedToUserData","description":"List of all assets"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnChanneldashboardListAssetsCanBeSuggestedToUserLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnChanneldashboardListAssetsCanBeSuggestedToUserData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size","total_page_count","total_count","sort"],"properties":{"items":{"type":"array","description":"Array of assets","items":{"$ref":"#/definitions/LearnChanneldashboardListAssetsCanBeSuggestedToUserItems"}},"count":{"type":"integer","description":"The total number of items returned"},"has_more_data":{"type":"boolean","description":"Returns "true" if the current page is not the last page"},"cursor":{"type":"string","description":"The unique ID used to temporarily store search parameters"},"current_page":{"type":"integer","description":"The page number of the current page"},"current_page_size":{"type":"integer","description":"The number of items per page"},"total_page_count":{"type":"integer","description":"The total number of pages returned"},"total_count":{"type":"integer","description":"The total number of items"},"sort":{"type":"array","description":"An array of applied sorting fields","items":{"$ref":"#/definitions/LearnChanneldashboardListAssetsCanBeSuggestedToUserSort"}}}},"LearnChanneldashboardListAssetsCanBeSuggestedToUserItems":{"required":["id","title"],"properties":{"id":{"type":"integer","description":"ID of the asset"},"title":{"type":"string","description":"Title of the asset"},"content_type":{"type":"string","description":"The type of the asset"},"content_type_label":{"type":"string","description":"The translated label of the asset type"}}},"LearnChanneldashboardListAssetsCanBeSuggestedToUserSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"type":"string","description":"The sorting field name"},"sort_dir":{"type":"string","description":"The sorting direction. Possible values are "asc" for ascending or "desc" for descending."}}},"LearnChanneldashboardListAssetsCanBeSuggestedToUserLinks":{},"LearnClassroomBatchSessionsSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects with data to be imported (must not be empty)","items":{"$ref":"#/definitions/LearnClassroomBatchSessionsItems"}},"options":{"$ref":"#/definitions/LearnClassroomBatchSessionsOptions","description":""}}},"LearnClassroomBatchSessionsItems":{"properties":{"course_id":{"type":"integer","description":"Course id (the session will be associated to the selected course). It's required if course_code is not provided."},"course_code":{"type":"string","description":"Course code (the session will be associated to the selected course). It's required if course_id is not provided."},"session_code":{"type":"string","description":"Session code."},"session_name":{"type":"string","description":"Session name. It's required if new session will be created (if update_session_info is false or not provided)."},"session_maximum_enrollments":{"type":"integer","description":"Session maximum enrollments - Skip this field if session_code already exists"},"session_minimum_enrollments":{"type":"integer","description":"Session minimum enrollments - Skip this field if session_code already exists"},"session_last_subscription_date":{"type":"string","format":"date","description":"Session last subscription date - Skip this field if session_code already exists. The date format should be "yyyy-mm-dd"."},"session_other_info":{"type":"string","description":"Session other info. Skip this field if session_code already exists"},"completion_type":{"type":"string","description":"Available options: “Online”, “Evaluation”. When not defined, the default value is “Evaluation”. Skip this field if session_code already exists"},"score_base":{"type":"integer","description":"Score base for completion_type “Evaluation”. When not defined, default value is 100 (only if completion_type = “Evaluation”). Skip this field if session_code already exists"},"date_name":{"type":"string","description":"Date name."},"date":{"type":"string","format":"date","description":"Date of the session date, it must be unique in association to the session_id/session_code. If the date is already existing for the same session_code, all fields listed below won’t be imported and an error will be returned “The session date already exists”. The date format should be "yyyy-mm-dd"."},"timezone":{"type":"string","description":"Timezone of the session date. By default it will be the user default TimeZone"},"time_start":{"type":"string","description":"Time start of the session date. The time format should be "H:i:s" or "G:i:s""},"time_end":{"type":"string","description":"Time end of the session date. The time format should be "H:i:s" or "G:i:s""},"break_start":{"type":"string","description":"Break start of the session date. The time format should be "H:i:s" or "G:i:s""},"break_end":{"type":"string","description":"Break end of the session date. The time format should be "H:i:s" or "G:i:s""},"location_name":{"type":"string","description":"If the location name already exists, associate the date to that location, otherwise create first a new one"},"location_address":{"type":"string","description":"If the location name already exists, skip this field, otherwise add the location address to the new location"},"location_country":{"type":"string","description":"f the location name already exists, skip this field, otherwise add the location country to the new location. Value should be one of the existing ones"},"classroom_name":{"type":"string","description":"If the same class_room name for the same location already exists, associate it to the session, otherwise create a new one and then associate it."},"effective_duration":{"type":"integer","description":"Effective duration in minutes for session date."}},"required":["session_code","date_name","date","time_start","time_end","location_name"]},"LearnClassroomBatchSessionsOptions":{"properties":{"update_session_info":{"type":"boolean","description":"If set to true, and the session of the course already exists, it will be updated with the new values."}}},"LearnClassroomBatchSessionsResponse":{"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/LearnClassroomBatchSessionsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnClassroomBatchSessionsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnClassroomBatchSessionsData":{"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"},"session_id":{"type":"integer","description":"id of session created"}}},"LearnClassroomBatchSessionsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnClassroomBatchSessionsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnClassroomBatchSessionsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnClassroomBatchSessionsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnClassroomBatchSessionsLast","description":"Link to the last page"}}},"LearnClassroomBatchSessionsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnClassroomBatchSessionsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnClassroomBatchSessionsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnClassroomBatchSessionsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnClassroomImporterFieldsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnClassroomImporterFieldsData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnClassroomImporterFieldsData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/LearnClassroomImporterFieldsFields"}}}},"LearnClassroomImporterFieldsFields":{},"LearnClassroomCreateClassroomSchema":{"type":"object","required":["id_location","name","seats"],"properties":{"id_location":{"type":"integer","description":"The ID of the location the classroom belongs to"},"name":{"type":"string","description":"The classroom name"},"seats":{"type":"integer","description":"The number of seats available in the classroom. Must be greater than zero"},"equipment":{"type":"string","description":"A description of the classroom equipment (e.g.: projector, air conditioning)"},"details":{"type":"string","description":"Some detail"}}},"LearnClassroomCreateClassroomResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnClassroomCreateClassroomData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnClassroomCreateClassroomData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"id_classroom":{"type":"integer","description":"The ID of the newly created classroom, if success is true."},"message":{"type":"string","description":"The error message, in case of error"},"code":{"type":"integer","description":"The error code, in case of error"}}},"LearnClassroomUpdateClassroomSchema":{"type":"object","required":["name","seats"],"properties":{"name":{"type":"string","description":"The classroom name"},"seats":{"type":"integer","description":"The number of seats available in the classroom. Must be greater than zero"},"equipment":{"type":"string","description":"A description of the classroom equipment (e.g.: projector, air conditioning)"},"details":{"type":"string","description":"Additional details about the classroom"}}},"LearnClassroomUpdateClassroomResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnClassroomUpdateClassroomData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnClassroomUpdateClassroomData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"}}},"LearnClassroomDeleteClassroomResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnClassroomDeleteClassroomData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnClassroomDeleteClassroomData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"The error message, in case of error"},"code":{"type":"integer","description":"The error code, in case of error"}}},"LearnClassroomViewClassroomResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Classroom data","items":{"$ref":"#/definitions/LearnClassroomViewClassroomData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnClassroomViewClassroomData":{"required":["id_classroom","id_location","seats","name","equipment","details"],"properties":{"id_classroom":{"type":"integer","description":"ID of the classroom"},"id_location":{"type":"integer","description":"ID of the location of the classroom"},"seats":{"type":"integer","description":"Number of seats of the classroom"},"name":{"type":"string","description":"Name of the classroom"},"equipment":{"type":"string","description":"A description of the classroom equipment (e.g.: conditioning air)"},"details":{"type":"string","description":"Details of the classroom"}}},"LearnClassroomListClassroomsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnClassroomListClassroomsData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnClassroomListClassroomsData":{"required":["items"],"properties":{"items":{"type":"array","description":"The list of calassrooms","items":{"$ref":"#/definitions/LearnClassroomListClassroomsItems"}}}},"LearnClassroomListClassroomsItems":{"required":["id_classroom","id_location","seats","name","equipment","details"],"properties":{"id_classroom":{"type":"integer","description":"ID of the classroom"},"id_location":{"type":"integer","description":"ID of the location of the classroom"},"seats":{"type":"integer","description":"Number of seats of the classroom"},"name":{"type":"string","description":"Name of the classroom"},"equipment":{"type":"string","description":"A description of the classroom equipment (e.g.: conditioning air)"},"details":{"type":"string","description":"Details of the classroom"}}},"LearnCourseCreateSchema":{"type":"object","properties":{"code":{"type":"string","description":"The code of the course"},"provider":{"type":"string","description":"The CSP of the course (foreign key - needed only when importing external course from catalogue)"},"name":{"type":"string","description":"The name of the course. The name cannot be composed of special characters only"},"description":{"type":"string","description":"The description of the course"},"course_type":{"description":"The type of the course","enum":["elearning","classroom"],"type":"string"},"image":{"type":"string","description":"Course thumbnail encoded in the base64 format, mutually exclusive with parameter 'image_id'"},"image_id":{"type":"string","description":"Course thumbnail asset id, mutually exclusive with parameter 'image'"},"additional_fields":{"$ref":"#/definitions/LearnCourseCreateAdditionalFields","description":"Additional fields values. For "date" type the date format should be "yyyy-mm-dd" (if not passed, it will be reset). This field becomes mandatory if there is at least one mandatory additional field"},"status":{"description":"Takes one of two values 'published' or 'unpublished'","enum":["published","unpublished"],"type":"string"},"label":{"type":"integer","description":"Id of Learning label"},"category":{"type":"integer","description":"The ID of a category"},"language":{"type":"string","description":"The language of the course (e.g. 'engish', 'italian', 'french', etc...)"},"channels":{"type":"array","description":"Array of channel Ids with the selected state","items":{"type":"integer"}},"credits":{"type":"integer","description":"The credits assigned to the course. The value must not be negative"},"prerequisites_policy":{"type":"integer","description":"Navigation policy: either 1 (Free Learning path), 2 (Sequential Learning path), 3 (Final Test) or 4 (Pre Test). 2,3 and 4 are allowed only for elearning courses, while 1 or no parameter at all is allowed also for classroom"},"enable_self_unenrollment":{"type":"integer","description":"Either 0 or 1, enable self unenrollment"},"enable_session_self_unenrollment":{"type":"integer","description":"Either 0 or 1, enable session self unenrollment"},"enable_unenrollment_on_course_completion":{"type":"integer","description":"Either 0 or 1, enable unenrollment on course completion"},"enable_session_change":{"type":"integer","description":"Either 0 or 1, enable the user to change the session they are enrolled in"},"max_attempts":{"type":"integer","description":"Number of attempts or set to 0 for unlimited failed attempts allowed for this course's training materials."},"show_rules":{"type":"integer","description":"Either 0 (Everyone, and show on home page), 1 (Only for logged in users) or 2 (Only users subscribed to the course)"},"max_num_subscribe":{"type":"integer","description":"Maximum number of subscriptions for this course"},"allow_overbooking":{"type":"integer","description":"Either 0 or 1 *part*of**[place users in waitlist]"},"allow_automatically_enroll":{"type":"integer","description":"Either 0 or 1 *part*of**[place users in waitlist]"},"course_demo":{"type":"string","description":"Name of uploaded file."},"can_subscribe":{"type":"integer","description":"Either 0 (Subscriptions are closed), 1 (Subscriptions are open) or 2 (Subscription is available during the following period)"},"sub_start_date":{"type":"string","format":"date","description":"Subscription start date. Only in case when 'can_subscribe' is '2'."},"sub_end_date":{"type":"string","format":"date","description":"Subscription end date. Only in case when 'can_subscribe' is '2'."},"subscribe_method":{"type":"integer","description":"Either 0 (Only Admin can subscribe users), 1 (Pending Admin Approval) or 2 (Free)"},"autoregistration_code":{"type":"string","description":"Code for the automatic subscription to a course."},"create_random_autoregistration_code":{"type":"integer","description":"Either 0 (false) or 1 (true) (flag, if set to true a code is randomly created instead of being selected. This flag cannot be set to true if the code is manually inserted)"},"selling":{"type":"integer","description":"Either 0 or 1. If this option is enabled the course will be available for purchase in the catalog by the users. This field will be usable only if the ecommerce app is active."},"price":{"type":"number","description":"The price of the course in cents of its currency. eg: 100 means the course costs 1 . Use dot for decimals"},"prices":{"$ref":"#/definitions/LearnCourseCreatePrices","description":"The object that contains the course prices"},"date_begin":{"type":"string","format":"date","description":"Course validity begin date (in format yyyy-MM-dd)."},"date_end":{"type":"string","format":"date","description":"Course validity end date (in format yyyy-MM-dd)."},"soft_deadline":{"type":"integer","description":"Either 0 or 1. If value is 1 then begin and end date are not taken in consideration. Default value is null."},"valid_time":{"type":"integer","description":"This setting allows users to access this course only for a specific number of days (days of validity)"},"valid_time_type":{"type":"integer","description":"Either 0 (after first course access) or 1 (after being enrolled in the course)"},"duration_hours":{"type":"integer","description":"number of hours for calculate average time for course (only for E-Learning course)"},"duration_minutes":{"type":"integer","description":"number of minutes for calculate average time for course (only for E-Learning course)"},"duration_seconds":{"type":"integer","description":"number of seconds for calculate average time of course (only for E-Learning course)"},"assigned_certificate":{"type":"integer","description":"Id of learning certificate."},"resume_autoplay":{"type":"integer","description":"Either 0 or 1. Directly play first item (or resume the last played object) when entering a course."},"enable_background_image":{"type":"boolean","description":"Enable background image. Either 0 or 1."},"background_image":{"type":"string","description":"Background image encoded in the base64 format."},"image_format":{"type":"string","description":"Format of image, either 'tile' or 'fill'."},"enable_course_starting_view":{"type":"integer","description":"Enable course starting view. Either 0 or 1."},"starting_view":{"type":"integer","description":"Either 0 (Land directly on the course player page (one-page view)) or 1 (Course pre-page)."},"enable_table_contents_visibility":{"type":"integer","description":"Enable table contents visibility, either 0 or 1."},"table_contents_visibility":{"type":"integer","description":"Either 0 (Hide the table of contents when user enters the course) or 1 (Show the table of contents when user enters the course)."},"player_layout":{"type":"string","description":"Layout to display your course's training material. Either 'play_button', 'navigator' or 'listview'."},"enable_social_sharing":{"type":"integer","description":"Enable the social sharing. Either 0 or 1."},"course_sharing_permission":{"type":"integer","description":"Either 0 (Disable courses social sharing), 1 (Users can share a course on social networks anytime, if enrolled) or 2 (Users can share a course on social networks only if they completed the course);"},"course_user_share_permission":{"type":"integer","description":"Either 0 or 1. If the course is completed, user can also share his score."},"course_share_facebook":{"type":"integer","description":"Enable option for sharing the course on Facebook, either 0 or 1."},"course_share_twitter":{"type":"integer","description":"Enable option for sharing the course on Twitter, either 0 or 1."},"course_share_linkedin":{"type":"integer","description":"Enable option for sharing the course on Linkedin, either 0 or 1."},"course_share_google":{"type":"integer","description":"Enable option for sharing the course on Google, either 0 or 1."},"enable_rating":{"type":"integer","description":"Enable users to rate a course, either 0 or 1."},"course_rating_permission":{"type":"integer","description":"Еither 0, 1, 2, or 3. 0 - Disable course rating; 1 - Every user can rate a course, even if they're not enrolled in the course; 2 - Users can rate a course in which they're enrolled; 3 - Users can rate a course only if they've completed the course;"},"enable_deep_link":{"type":"integer","description":"Create and share a link from within the course's page. Users are automatically enrolled by accessing the link, either 0 or 1."},"deep_link":{"type":"integer","description":"Either 0 or 1. (flag, if '1' a deeplink needs to be calculated)"},"certification":{"type":"integer","description":"Id of certification."},"enable_coaching":{"type":"integer","description":"Either 0 or 1"},"learner_assignment":{"type":"integer","description":"Either 1, 2, 3 or 4. 1 - Automatically by maximizing by session's usage; 2 - Automatically by balancing coaching assignments; 3 - Learners must select their preferred coaching session; 4 - Manually by the admins;"},"coaching_option_allow_start_course":{"type":"integer","description":"Either 0 or 1. Allow learners to start the course even if the coaching session is scheduled for the future."},"coaching_option_allow_request_session_change":{"type":"integer","description":"Either 0 or 1. Allow learners to request a coaching session change"},"coaching_option_access_without_assign_coach":{"type":"integer","description":"Either 0 or 1. Allow users to enter the course even if they do not have an assigned coaching session."},"initial_score_mode":{"type":"integer","description":"Initial score mode"},"initial_object":{"type":"integer","description":"idOrg of learning_organization. Accepted only if the initial score is set to one specific object."},"prediction_id":{"type":"string","description":"The prediction ID of the suggested skills"},"suggested_skills":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCourseCreateSuggestedSkills"}},"equivalent_courses":{"$ref":"#/definitions/LearnCourseCreateEquivalentCourses","description":"The key of the array was the id of the course and value is the setting for using or not the bidirectional equivalence (0 meaning without bidirectional association, 1 meaning with bidirectional association and we will create second record with swap course ids (source and target))."},"decommissioning":{"$ref":"#/definitions/LearnCourseCreateDecommissioning","description":"Decommissioning info"},"skill_codes":{"type":"array","description":"Array with skill codes or empty array","items":{"type":"string"}}},"required":["name","description","course_type","status"]},"LearnCourseCreateAdditionalFields":{"required":["xxx"],"properties":{"xxx":{"type":"string","description":"Multiple additional fields may be added. Simply replace "xxx" with the ID of the additional field. The value may be an integer (e.g. for Dropdown additional fields) or string (Text additional field, Textarea additional field)"}}},"LearnCourseCreatePrices":{"properties":{"DTC":{"type":"integer","description":"Training Credits value"}}},"LearnCourseCreateSuggestedSkills":{"required":["code","name","score"],"properties":{"code":{"type":"string","description":"The code of the suggested skill"},"name":{"type":"string","description":"The name of the suggested skill"},"score":{"type":"number","format":"float","description":"The score of the suggested skill"}}},"LearnCourseCreateEquivalentCourses":{},"LearnCourseCreateDecommissioning":{"required":["decommissioned_at"],"properties":{"decommissioned_at":{"type":"string","description":"Date of decommissiong"},"removed_at":{"type":"string","description":"Date of course removal"}}},"LearnCourseCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseCreateData","description":"Information about the created course."},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseCreateData":{"required":["course_id","success"],"properties":{"course_id":{"type":"integer","description":"ID of the created course."},"success":{"type":"boolean","description":"Status of the operation"}}},"LearnCourseCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseCreateLast","description":"Link to the last page"}}},"LearnCourseCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseDeleteData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/LearnCourseDeleteLinks"}}}},"LearnCourseDeleteData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Operation result. Always returned as "true"."}}},"LearnCourseDeleteLinks":{},"LearnCourseIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseIndexData","description":"List of all retrieved subscription schemas"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of subscription schema info objects","items":{"$ref":"#/definitions/LearnCourseIndexItems"}},"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/LearnCourseIndexSort"}}}},"LearnCourseIndexItems":{"required":["id_course","name","description","date_last_updated","course_type","selling","code","slug_name","image","duration","language","language_label","price","is_new","is_opened","rating_option","current_rating","credits","img_url","can_rate","can_self_unenroll","category","enrollment_policy"],"properties":{"id_course":{"type":"integer","description":"ID of the course"},"name":{"type":"string","description":"Course name"},"uidCourse":{"type":"string","description":"Code id of the course"},"description":{"type":"string","description":"Course description"},"date_last_updated":{"type":"string","format":"date","description":"Last date the course has been updated, formatted as "yyyy-mm-dd hh:mm:ss", UTC timezone"},"course_type":{"type":"string","description":"Course type: "elearning|classroom","},"selling":{"type":"boolean","description":"flagged if the course is selling"},"code":{"type":"string","description":"the code for the course"},"slug_name":{"type":"string","description":"the slug for the course name"},"image":{"type":"string","description":"the filename for the course image"},"duration":{"type":"integer","description":"the duration in seconds"},"language":{"type":"string","description":"the language code for the course"},"language_label":{"type":"string","description":"Human readable language name"},"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/LearnCourseIndexMultiLanguages"}},"price":{"type":"string","description":"the price for the course"},"is_new":{"type":"string","description":"stringified flag to determine whether the course has been created within 1 day"},"is_opened":{"type":"string","description":"stringified flag to determine whether the course is open to subscription"},"rating_option":{"description":"Rating option","enum":["disabled","always","only_enrolled","only_completed"],"type":"string"},"current_rating":{"type":"number","format":"float","description":"The current average rating for the course"},"credits":{"type":"number","format":"float","description":"Course credits. If not set, the value is 0"},"img_url":{"type":"string","description":"the url for the course logo"},"can_rate":{"type":"boolean","description":"If the logged user can rate the course"},"can_self_unenroll":{"type":"boolean","description":"Whether or not the current user can self-unenroll from the course"},"start_date":{"type":"string","format":"date","description":"course starting time (if the course is type 'elearning')"},"end_date":{"type":"string","format":"date","description":"course ending time (if the course is type 'elearning')"},"category":{"$ref":"#/definitions/LearnCourseIndexCategory","description":"Object containing course category informations"},"enrollment_policy":{"type":"integer","description":"0 if only Admins can subscribe users; 1 if subject to Admin Approval; 2 if free"},"max_attempts":{"type":"integer","description":"Max number of attempts possible; null if not set"},"available_seats":{"$ref":"#/definitions/LearnCourseIndexAvailableSeats","description":"Available seats for the course, if course have session, data is split by session id. If not available, the default value is null"},"is_affiliate":{"type":"boolean","description":"Flag if the course is using Content Partner"},"partner_fields":{"type":"string","description":"Content Partner fields"},"partner_data":{"$ref":"#/definitions/LearnCourseIndexPartnerData","description":"Content Partner data"},"affiliate_price":{"type":"string","description":"Affiliate price"}}},"LearnCourseIndexMultiLanguages":{"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"}}},"LearnCourseIndexCategory":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"Id of course category"},"name":{"type":"string","description":"Name of course category"}}},"LearnCourseIndexAvailableSeats":{"required":["id"],"properties":{"id":{"type":"integer","description":"id is the id of the session; the value is the available seats for that session"}}},"LearnCourseIndexPartnerData":{"required":["id","referral_id","name","description","logo","city","country","state","address","phone","email","website","discount","affiliate_code","enable_affiliate","catalog_visible","course_visible","active","updated_at","updated_by"],"properties":{"id":{"type":"integer","description":"ID of the content partner resource"},"referral_id":{"type":"string","description":"The referral code"},"name":{"type":"string","description":"Json encoded object with type, value and values keys"},"description":{"type":"string","description":"Json encoded object with type, value and values keys"},"logo":{"type":"string","description":"Name of the logo resource - WILL BE DEPRECATED ON 2019-01-19"},"city":{"type":"string","description":"The name of the city - can be empty"},"country":{"type":"string","description":"The name of the country - can be empty"},"state":{"type":"string","description":"The name of the state - can be empty"},"address":{"type":"string","description":"The address - can be empty"},"phone":{"type":"string","description":"The phone - can be empty"},"email":{"type":"string","description":"The email - can be empty"},"website":{"type":"string","description":"The website - can be empty"},"discount":{"type":"string","description":"The discount - can be empty"},"affiliate_code":{"type":"string","description":"The affiliate_code - can be empty"},"enable_affiliate":{"type":"string","description":"Flag to know if the affiliate is enabled"},"catalog_visible":{"type":"string","description":"Flag to know if the catalog is visible"},"course_visible":{"type":"string","description":"Flag to know if the course is visible"},"active":{"type":"string","description":"Flag to know if the course is active"},"updated_at":{"type":"string","description":"The last update date"},"updated_by":{"type":"string","description":"The ID of the user that last updated the resource"},"logo_full_path":{"type":"string","description":"The full path of the logo"}}},"LearnCourseIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnCourseIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseIndexLast","description":"Link to the last page"}}},"LearnCourseIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseViewData","description":"Success or failure to find course"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseViewData":{"required":["id","name","slug_name","description","short_description","lang_code","type","status","status_identifier","is_published","can_self_unenroll","can_self_enroll","can_session_change","is_self_enrollment_available","certificate_url","has_overview","show_toc","show_lightbox_nav","in_soft_deadline","demo_file_type","enter_status","can_manage_course","max_attempts_reached","enrolled","on_sale","instructors","skills","rating_option","can_rate","current_rating","ratings_count","is_rated","background_image","flat_los","additional_fields","has_autoplay","course_date_start","course_date_end","enrollment_date_start","enrollment_date_end","player_appearance","focus_mode","harmony_tutoring","tree","can_enter","category","enrollment_policy","meta_description"],"properties":{"id":{"type":"integer","description":"ID of the course"},"name":{"type":"string","description":"Course name"},"code":{"type":"string","description":"The internal codename of the course"},"uidCourse":{"type":"string","description":"Code id of the course"},"provider":{"type":"integer","description":"Provider id of the course. If not set, the value is 0."},"slug_name":{"type":"string","description":"Course slug name"},"description":{"type":"string","description":"Course description"},"short_description":{"type":"string","description":"Course short description"},"credits":{"type":"number","format":"float","description":"Course credits. If not set, the value is 0."},"lang_code":{"type":"string","description":"The language of the course, e.g. "en", "bg""},"lang_name":{"type":"string","description":"Course default language name. Only available for E-learning courses when the multi-language feature is on."},"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/LearnCourseViewMultiLanguages"}},"type":{"description":"Course type","enum":["elearning","classroom"],"type":"string"},"status":{"description":"Enrollment status","enum":["subscribed","in_progress","completed"],"type":"string"},"status_identifier":{"description":"Enrollment status of the current user. null - not enrolled, "-2" - waiting, "-1" - to be confirmed, "0" - subscribed, "1" - in progress, "2" - completed, "3" - suspended, "4" - overbooking","enum":["null","-2","-1","0","1","2","3","4"],"type":"string"},"is_published":{"type":"boolean","description":"True if course is published or false if it's under maintenance"},"can_self_unenroll":{"type":"boolean","description":"Whether or not the current user can self-unenroll from the course"},"can_self_enroll":{"type":"boolean","description":"Whether or not the current user can self-enroll to the course"},"can_session_change":{"type":"boolean","description":"Whether or not the current user can change session of the course"},"is_self_enrollment_available":{"type":"boolean","description":"Whether the user can self-enroll in (or buy) the course"},"certificate_url":{"type":"string","description":"The current S3 PDF certificate URL (if any)"},"has_overview":{"type":"boolean","description":"Determinate if the course can show the overview page"},"show_toc":{"type":"boolean","description":"Determinate if the course player should display or not the Table of Content (course navigation)"},"show_lightbox_nav":{"type":"boolean","description":"Determine if the course player should display the "Next" and "Previous" buttons when using the Lightbox mode (course navigation)"},"level":{"description":"The enrollment level of the current user. Possible values = "student", "tutor", "instructor", "coach"","enum":["student","tutor","instructor","coach"],"type":"string"},"in_soft_deadline":{"type":"boolean","description":"Flag if the course is in soft deadline stage"},"demo_file_type":{"type":"string","description":"Type of the demo file of the course"},"validity":{"$ref":"#/definitions/LearnCourseViewValidity","description":"Settings for validity of the course. Only returned if days of validity are set."},"enter_status":{"$ref":"#/definitions/LearnCourseViewEnterStatus","description":"Current user enter status"},"can_manage_course":{"type":"boolean","description":"Flag if the current user can manage this course"},"is_affiliate":{"type":"boolean","description":"Flag if the course is using Content Partner"},"partner_fields":{"type":"string","description":"Content Partner fields"},"partner_data":{"$ref":"#/definitions/LearnCourseViewPartnerData","description":"Content Partner data"},"max_attempts_reached":{"type":"boolean","description":"Flag is the current user reached the max attempts of the course"},"redirect_to":{"type":"string","description":"Redirect the user to this url when visit the course page. Only when SEO App is active."},"self_unenrollment_settings":{"$ref":"#/definitions/LearnCourseViewSelfUnenrollmentSettings","description":"Object of a course 'Self-Unenrollment Settings' information. Can be seen only by Super Admin or Power User who manages this course"},"enrolled":{"$ref":"#/definitions/LearnCourseViewEnrolled","description":"Object with information for enrollment of current user to course"},"learningplans":{"type":"array","description":"Ids of Learning Plans that current user is assigned and the course is part of","items":{"type":"integer"}},"on_sale":{"type":"boolean","description":"Whether this course is on sale (through the ecommerce functionality)"},"instructors":{"type":"array","description":"The instructors inside the course","items":{"$ref":"#/definitions/LearnCourseViewInstructors"}},"skills":{"type":"array","description":"Array of skills associated with the course","items":{"$ref":"#/definitions/LearnCourseViewSkills"}},"rating_option":{"description":"Rating option","enum":["disabled","always","only_enrolled","only_completed"],"type":"string"},"can_rate":{"type":"boolean","description":"If the logged user can rate the course"},"current_rating":{"type":"number","format":"float","description":"The current average rating for the course"},"ratings_count":{"type":"integer","description":"The total count of votes given to the course"},"is_rated":{"type":"boolean","description":"Indicates whether the course has a rating (whether a user has given their rating)"},"user_rating":{"type":"integer","description":"The rating given to the course by the current user. Only returned if the user has rated the course"},"background_image":{"$ref":"#/definitions/LearnCourseViewBackgroundImage","description":"The course background image information"},"flat_los":{"type":"array","description":"The list of all learning objects (as a flat structure), grouped by folders, related to the given course","items":{"$ref":"#/definitions/LearnCourseViewFlatLos"}},"additional_fields":{"type":"array","description":"The list of course additional fields","items":{"$ref":"#/definitions/LearnCourseViewAdditionalFields"}},"has_autoplay":{"type":"boolean","description":"Whether or not next chapter should be automatically played after the previous is completed"},"deadline":{"type":"string","description":"The maximum date (in MYSQL format UTC) by which this course should be completed. It can be the course deadline or the enrollment one"},"course_date_start":{"type":"string","format":"date","description":"The date and time in format "yyyy-mm-dd HH:mm:ss" (UTC) from which the user can access the course. The value can be null when the date is not set for the course"},"course_date_end":{"type":"string","format":"date","description":"The date and time in in format "yyyy-mm-dd HH:mm:ss" (UTC) by which the user can access the course. The value can be null when the date is not set for the course"},"enrollment_date_start":{"type":"string","format":"date","description":"Starting date and time in format "yyyy-mm-dd HH:mm:ss" (UTC) of the enrollment of the user, who requested the API. Its value can be null"},"enrollment_date_end":{"type":"string","format":"date","description":"Expiration date and time in format "yyyy-mm-dd HH:mm:ss" (UTC) of the enrollment of the user, who requested the API. Its value can be null"},"completion_date":{"type":"string","description":"The date when the course was completed"},"last_played_object":{"type":"integer","description":"The last object played in the course"},"last_completed_object":{"type":"integer","description":"The last object completed in the course"},"thumbnail":{"type":"string","description":"DEPRECATED. Please use "course_thumbnail". URL to thumbnail of the course"},"header_layout":{"$ref":"#/definitions/LearnCourseViewHeaderLayout","description":"Header Layout settings for new Course page. Only returned if a custom header layout is specified for the course"},"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 active"},"harmony_tutoring":{"type":"boolean","description":"Whether the Harmony Tutoring is active"},"cover_url":{"type":"string","description":"URL to cover image of the course. Only returned if a cover image is set"},"course_thumbnail":{"$ref":"#/definitions/LearnCourseViewCourseThumbnail","description":"Course thumbnail object with additional information. Only for admins and PU with Select or Manage thumbnails permissions"},"demo_file":{"type":"string","description":"Optional demo_file of the course"},"permissions":{"type":"array","description":"An array of permission records for the user in this course","items":{"type":"string"}},"chapter_sequence":{"type":"array","description":"Flat, single level, array of LO IDs in the course, in the correct playable order (respecting prerequisites requirements and LO order from the Training Materials management area of the course)","items":{"type":"string"}},"deeplink":{"type":"string","description":"The URL signature part (i.e. hash=<signature>) to append to the deeplink for this course/chapter. Only available if course has deeplinking enabled."},"final_score":{"type":"number","format":"double","description":"The final score calculated for the user"},"available_seats":{"type":"array","description":"Available seats for the course, if course have session, data is splitted by session id","items":{"type":"integer"}},"available_seats_course":{"type":"integer","description":"Available seats for the course. Only returned if the course has a maximum enrollment quota set"},"maximum_enrollment_quota":{"type":"integer","description":"Maximum enrollment quota for the course. Only returned if it is set in the course"},"power_user_total_seats":{"type":"integer","description":"The total count of seats (purchased + extra) owned by the current user. Only returned if the user is a PU and can buy seats and is assigned to the course"},"power_user_available_seats":{"type":"integer","description":"The count of seats still available for the current user. Only returned if the user is a PU and can buy seats and is assigned to the course"},"allow_overbooking":{"type":"integer","description":"Flag, which points, if the course overbooking is allowed or not. Possible values 1 and 0"},"is_soft_deadline_enabled":{"type":"boolean","description":"Whether the soft deadline is enabled for this course. Only returned if the platform default setting was overridden in this course"},"social_settings":{"$ref":"#/definitions/LearnCourseViewSocialSettings","description":"An optional object containing settings for sharing courses on social networks"},"sessions":{"type":"array","description":"An array with session objects","items":{"$ref":"#/definitions/LearnCourseViewSessionsL2"}},"tree":{"type":"array","description":"Array of learning objects, folders and their children inside the course, in a tree like structure","items":{"$ref":"#/definitions/LearnCourseViewTree"}},"can_enter":{"type":"boolean","description":"Returns true or false based on that if the user can_enter in the current course or not, this property is available only when the user is logged in."},"can_enter_reason":{"type":"string","description":"Returns the reason, if the user can not enter the course"},"can_enter_reason_code":{"type":"string","description":"The unique code of the reason why the user cannot enter the course. Only returned if the user cannot access the course"},"category":{"type":"array","description":"Array containing course category information","items":{"$ref":"#/definitions/LearnCourseViewCategory"}},"affiliate_price":{"type":"string","description":"Affiliate price"},"enrollment_policy":{"type":"integer","description":"0 if only Admins can subscribe users; 1 if subject to Admin Approval; 2 if free"},"max_attempts":{"type":"integer","description":"Max number of attempts possible; null if not set"},"waiting_list":{"type":"number","description":"How many people are in the waiting list of this course"},"has_esignature_enabled":{"type":"boolean","description":"Whether E-Signature is enabled for this course. Returned only when E-Signature is enabled for that course"},"esignature_status":{"description":"E-Signature status. Returned only when E-Signature is enabled for that course and the currently logged in user is enrolled into the course","enum":["locked","pending","signed"],"type":"string"},"esignature_title":{"type":"string","description":"ESignature title for the course. Returned only when E-Signature is enabled for that course"},"esignature_description":{"type":"string","description":"ESignature description for the course. Returned only when E-Signature is enabled for that course"},"esignature_date":{"type":"string","description":"The date in which the ESignature was signed. Returned only when E-Signature is enabled for that course and the user has signed it"},"min_session_to_pass":{"type":"integer","description":"(New ILT only) Min number of sessions that the user has to pass to complete the course"},"max_session_to_pass":{"type":"integer","description":"(New ILT only) Total number of sessions for this course"},"has_session_completion_rule":{"type":"boolean","description":"(New ILT only) Flag if the course has a completion rule based on session completion"},"ics_url":{"type":"string","description":"URL for ics file to sync with a calendar client"},"catalog_show_alternative_learning_plans":{"type":"boolean","description":"Show alternative LPs about this course"},"catalog_show_alternative_subscription_plans":{"type":"boolean","description":"Show alternative subscriptions plans about this course"},"catalog_show_buy_now":{"type":"boolean","description":"Show buy now button on this course"},"ecommerce_pricing_system_default":{"type":"integer","description":"The ecommerce default pricing system id"},"ecommerce":{"$ref":"#/definitions/LearnCourseViewEcommerce","description":"The ecommerce pricing system"},"meta_description":{"type":"string","description":"Seo meta description content. Can be null"},"certification":{"$ref":"#/definitions/LearnCourseViewCertification","description":"Certification related to this course. When the new certification feature is active, this field represents a Legacy Certification."},"certification_award":{"$ref":"#/definitions/LearnCourseViewCertificationAward","description":"Active certification award for the certification related to this course. When the new certification feature is active, this field represents a Legacy Certification Award."}}},"LearnCourseViewMultiLanguages":{"required":["code","name","browser_code","total_training_materials"],"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"},"total_training_materials":{"type":"integer","description":"Total number of training materials of the course for the language"}}},"LearnCourseViewValidity":{"required":["days","trigger"],"properties":{"days":{"type":"integer","description":"The number of days of validity for the course"},"trigger":{"description":"Whether the days of validity are calculated from the first access or from when the enrollment is created","enum":["first_access","enrollment_creation"],"type":"string"}}},"LearnCourseViewEnterStatus":{"required":["status","price"],"properties":{"status":{"description":"Enter status","enum":["play","enroll","buy","locked"],"type":"string"},"price":{"type":"integer","description":"Price of the course"},"prices":{"$ref":"#/definitions/LearnCourseViewPrices","description":"The object that contains the course prices"},"sessions":{"type":"array","description":"Session in this course","items":{"$ref":"#/definitions/LearnCourseViewSessions"}},"subscription":{"$ref":"#/definitions/LearnCourseViewSubscription","description":"Subscription information. Only returned if the current user can access this course thanks to an active subscription plan"}}},"LearnCourseViewPrices":{"properties":{"DTC":{"type":"integer","description":"Training Credits value"}}},"LearnCourseViewSessions":{"required":["value","label"],"properties":{"value":{"type":"string","description":"ID of the session"},"label":{"type":"string","description":"Name of the session"}}},"LearnCourseViewSubscription":{"properties":{"selection_status":{"type":"integer","description":"Whether or not the subscription includes the children of the object of the subscription"},"name":{"type":"string","description":"Subscription bundle name"},"start_date":{"type":"string","description":"Starting date of the subscription"},"end_date":{"type":"string","description":"Ending date of the subscription"},"record_id":{"type":"integer","description":"Record ID of the subscription"},"availability":{"type":"integer","description":"Availability of the subscription"},"users_associated":{"type":"integer","description":"A count of the users associated with the subscription"},"enrollments_done":{"type":"integer","description":"A count of the enrollments in this subscription"},"type":{"type":"integer","description":"Type of the subscription"},"status":{"type":"integer","description":"Whether the subscription is active or not"},"object_type":{"type":"integer","description":"Type of the object of the subscription"},"object_id":{"type":"integer","description":"Unique ID of the object of the subscription"},"price":{"type":"string","description":"Price of the subscription. Could be integer ot "free""}},"required":["name"]},"LearnCourseViewPartnerData":{"required":["id","referral_id","name","description","logo","city","country","state","address","phone","email","website","discount","affiliate_code","enable_affiliate","catalog_visible","course_visible","active","updated_at","updated_by"],"properties":{"id":{"type":"integer","description":"ID of the content partner resource"},"referral_id":{"type":"string","description":"The referral code"},"name":{"type":"string","description":"Json encoded object with type, value and values keys"},"description":{"type":"string","description":"Json encoded object with type, value and values keys"},"logo":{"type":"string","description":"Name of the logo resource - WILL BE DEPRECATED ON 2019-01-19"},"city":{"type":"string","description":"The name of the city - can be empty"},"country":{"type":"string","description":"The name of the country - can be empty"},"state":{"type":"string","description":"The name of the state - can be empty"},"address":{"type":"string","description":"The address - can be empty"},"phone":{"type":"string","description":"The phone - can be empty"},"email":{"type":"string","description":"The email - can be empty"},"website":{"type":"string","description":"The website - can be empty"},"discount":{"type":"string","description":"The discount - can be empty"},"affiliate_code":{"type":"string","description":"The affiliate_code - can be empty"},"enable_affiliate":{"type":"string","description":"Flag to know if the affiliate is enabled"},"catalog_visible":{"type":"string","description":"Flag to know if the catalog is visible"},"course_visible":{"type":"string","description":"Flag to know if the course is visible"},"active":{"type":"string","description":"Flag to know if the course is active"},"updated_at":{"type":"string","description":"The last update date"},"updated_by":{"type":"string","description":"The ID of the user that last updated the resource"},"logo_full_path":{"type":"string","description":"The full path of the logo"}}},"LearnCourseViewSelfUnenrollmentSettings":{"required":["self_unenrollment_settings","allow_self_unenrollment_from_completed_course"],"properties":{"self_unenrollment_settings":{"type":"boolean","description":"Allow self-unenrollment from this course"},"allow_self_unenrollment_from_session":{"type":"boolean","description":"Allow self-unenrollment from this session. Only for classroom"},"allow_self_unenrollment_from_completed_course":{"type":"boolean","description":"Allow self-unenrollment from the course even if the learner has completed it"},"allow_change_session":{"type":"boolean","description":"Allow user to change session, Only for classroom"}}},"LearnCourseViewEnrolled":{"properties":{"date_enrolled":{"type":"string","description":"Date of the user enrollment (format yyyy-MM-dd HH:mm:ss)"},"is_enrolled":{"type":"boolean","description":"Whether or not the current user is enrolled to course"},"waiting_list":{"type":"boolean","description":"Whether or not the enrollment is waiting"},"can_enroll_session":{"type":"boolean","description":"Whether or not the current user can switch to this session of the course"},"enrollment_fields_completed":{"type":"boolean","description":"Whether the user filled at least the mandatory enrollment additional fields"},"language":{"type":"string","description":"Enrollment language. Only available for E-learning courses when the multi-language feature is on."}},"required":["is_enrolled"]},"LearnCourseViewInstructors":{"required":["username","instructor_id"],"properties":{"username":{"type":"string","description":"The username of the instructor"},"instructor_id":{"type":"integer","description":"The uniquer id of the instructor"},"firstname":{"type":"string","description":"The firstname of the instructor"},"lastname":{"type":"string","description":"The lastname of the instructor"},"avatar_url":{"type":"string","description":"The avatar URL of the instructor"},"email":{"type":"string","description":"The email address of the instructor. Only returned if the user is logged"}}},"LearnCourseViewSkills":{"required":["title"],"properties":{"title":{"type":"string","description":"Title of the skill in the selected language"}}},"LearnCourseViewBackgroundImage":{"properties":{"url":{"type":"string","description":"The background image URL for the course or the default fallback image for all courses"},"aspect_ratio":{"description":"The preferred player background image stretch mode, selected for this course (or platform wide)","enum":["fill","tile"],"type":"string"}}},"LearnCourseViewFlatLos":{"required":["id","title","lev","iLeft","iRight","items","items_count"],"properties":{"id":{"type":"string","description":"The internal ID of the folder"},"title":{"type":"string","description":"The name of the folder. If it is root folder then the course title is used"},"lev":{"type":"string","description":"The level of the folder in the tree structure."},"iLeft":{"type":"string","description":"Id for the node used as the left index of the nested set for the learning objects tree"},"iRight":{"type":"string","description":"Id for the node used as the right index of the nested set for the learning objects tree"},"items":{"type":"array","description":"List of all learning objects that are in the folder","items":{"$ref":"#/definitions/LearnCourseViewItems"}},"items_count":{"type":"integer","description":"The number of learning objects in the folder"}}},"LearnCourseViewItems":{"required":["id","title","description","type"],"properties":{"id":{"type":"string","description":"The internal ID of the learning object"},"title":{"type":"string","description":"The title of the learning object"},"description":{"type":"string","description":"The description of the learning object"},"type":{"type":"string","description":"The type of the learning object - file, video, etc..."},"lti_version":{"description":"The version of the learning object returned only if it's of type LTI and toggle RELEASE/WEEKLY/LTI-ADVANTAGE-13 is ON.","enum":["LTI-1p0","LTI-1p3"],"type":"string"},"proctoring":{"$ref":"#/definitions/LearnCourseViewProctoring","description":"Proctoring settings. Returned only if the training materials are of type test, the Honorlock App is active and the proctoring is enabled for the material"}}},"LearnCourseViewProctoring":{"required":["config_id","test_config_id"],"properties":{"config_id":{"type":"integer","description":"Proctoring tool configuration ID"},"test_config_id":{"type":"integer","description":"Proctoring test configuration ID"}}},"LearnCourseViewAdditionalFields":{"required":["id","title","type","visible_to_user","settings","value"],"properties":{"id":{"type":"integer","description":"The ID of the field"},"title":{"type":"string","description":"The name of the field,"},"type":{"type":"string","description":"The type of the field"},"visible_to_user":{"type":"string","description":"The user visibility of the field. Possible values 0,1"},"settings":{"type":"string","description":"Other field settings"},"mandatory":{"type":"boolean","description":"Whether the field is mandatory or not."},"value":{"type":"string","description":"The field content"}}},"LearnCourseViewHeaderLayout":{"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 a color is set"}}},"LearnCourseViewCourseThumbnail":{"properties":{"id":{"type":"integer","description":"An internal ID of the image, being previewed. This will be empty sometimes (when the image was just uploaded for example and is not yet saved to the database)"},"name":{"type":"string","description":"The file name (human friendly version)"},"filename":{"type":"string","description":"The filename"},"original_filename":{"type":"string","description":"The filename"},"created_on":{"type":"number","format":"double","description":"The creation time timestamp"},"created_by":{"$ref":"#/definitions/LearnCourseViewCreatedBy","description":"An object representing the "author" of the image. Notice that this will be null for old images"},"built_in":{"type":"boolean","description":"Indicates whether this thumbnail is one of the built in or it is uploaded."},"filesize":{"type":"string","description":"File size in bytes."},"width":{"type":"string","description":"Thumbnail width in px"},"height":{"type":"string","description":"Thumbnail height in px"},"url":{"type":"string","description":"An S3 URL to the image resource"},"params":{"$ref":"#/definitions/LearnCourseViewParams","description":"Thumbnail additional information: file size, width, height and etc.."},"actions":{"type":"array","description":"Array of actions that current user can take on this course thumbnail. Possible values: delete","items":{"type":"string"}},"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."}},"required":["url","actions","used_by_count"]},"LearnCourseViewCreatedBy":{"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"}}},"LearnCourseViewParams":{"properties":{"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"}}},"LearnCourseViewSocialSettings":{"required":["sharing_mode","networks"],"properties":{"sharing_mode":{"type":"enum","description":""},"networks":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCourseViewNetworks"}}}},"LearnCourseViewNetworks":{"required":["type","url"],"properties":{"type":{"type":"string","description":"Social network type: "facebook", "twitter", "linkedin", "google-plus""},"url":{"type":"string","description":"Course URL"},"description":{"type":"string","description":"Course description"}}},"LearnCourseViewSessionsL2":{"required":["id_session","attendance_type","uid_session","name","slug_name","description","start_date","end_date","last_subscription_date","custom_deadline_days","max_enroll","enrolled","dates","additional_fields"],"properties":{"id_session":{"type":"integer","description":"The unique identifier of the session"},"attendance_type":{"description":"The attendance type of this sessions based on configuration of all the events (only for NEW ILT courses, can be NULL)","enum":["onsite","online","flexible","blended"],"type":"string"},"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)"},"uid_session":{"type":"string","description":"Unique code of the session"},"name":{"type":"string","description":"The session name"},"slug_name":{"type":"string","description":"The slug name of this session"},"description":{"type":"string","description":"The session description"},"start_date":{"type":"string","format":"date","description":"The UTC start datetime for the session"},"end_date":{"type":"string","format":"date","description":"The UTC end datetime for the session"},"last_subscription_date":{"type":"string","format":"date","description":"The UTC of the last subscription date (Available only for Classroom courses)"},"custom_deadline_days":{"type":"number","description":"The number of days prior to the session start date after which it is not possible to enroll in the session anymore. It can be null."},"min_enroll":{"type":"integer","description":"The minimum number of enrollments (Available only for Classroom courses)"},"max_enroll":{"type":"integer","description":"The number of Maximum enrollments"},"is_instructor":{"type":"boolean","description":"(New ILT only) Flag if the current user is instructor for this session or event"},"is_session_instructor":{"type":"boolean","description":"(New ILT only) Flag if the current user is instructor for this session"},"is_event_instructor":{"type":"boolean","description":"(New ILT only) Flag if the current user is instructor for the event"},"enrolled":{"type":"array","description":"Array with information for enrollment of current user to session","items":{"$ref":"#/definitions/LearnCourseViewEnrolledL2"}},"instructors":{"type":"array","description":"(New ILT only) Array containing the instructor list for this session","items":{"$ref":"#/definitions/LearnCourseViewInstructorsL2"}},"dates":{"type":"array","description":"Array of the session's dates","items":{"$ref":"#/definitions/LearnCourseViewDates"}},"locations":{"type":"array","description":"An array of all locations used throughout the sessions and dates of this course","items":{"$ref":"#/definitions/LearnCourseViewLocations"}},"additional_fields":{"type":"array","description":"An array of all additional session fields","items":{"$ref":"#/definitions/LearnCourseViewAdditionalFieldsL2"}}}},"LearnCourseViewEnrolledL2":{"required":["is_enrolled","count_enrolled","count_instructor","count_instructor_waitlist","count_tutor","count_tutor_waitlist","count_learner","count_learner_waitlist","status","evaluation_type"],"properties":{"is_enrolled":{"type":"boolean","description":"Whether or not the current user is enrolled to session"},"count_enrolled":{"type":"boolean","description":"How many enrollments has this session"},"count_instructor":{"type":"integer","description":"Count of instructors assigned to this session"},"count_instructor_waitlist":{"type":"integer","description":"Count of instructors on the waitlist"},"count_tutor":{"type":"integer","description":"Count of tutors assigned to this session"},"count_tutor_waitlist":{"type":"integer","description":"Count of tutors on the waitlist"},"count_learner":{"type":"integer","description":"Count of learners assigned to this session"},"count_learner_waitlist":{"type":"integer","description":"Count of learners on the waitlist"},"waiting_list":{"type":"boolean","description":"Whether or not the enrollment is waiting"},"status":{"description":"User enrollment status in the session","enum":["subscribed","in_progress","completed"],"type":"string"},"evaluation_type":{"type":"string","description":"Evaluation type Classroom: 0=>manual, 1=> online test, Evaluation type Webinar: joined_webinar, online_test, manual"}}},"LearnCourseViewInstructorsL2":{"required":["firstname","lastname","username"],"properties":{"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"}}},"LearnCourseViewDates":{"required":["date","name","timezone"],"properties":{"date":{"type":"string","description":"The date of the current session"},"name":{"type":"string","description":"Name of this session's date"},"description":{"type":"string","description":"The session date description, present in case of Webinar sessions"},"start_hour":{"type":"string","description":"Starting hour of this session's date"},"end_hour":{"type":"string","description":"Ending hour of this session's date"},"id_location":{"type":"integer","description":"ID of the Location of given session date (Available only for Classroom courses)"},"id_classroom":{"type":"integer","description":"ID of the Classroom for the given session date (Available only for Classroom courses)"},"classroom_name":{"type":"string","description":"Name of the Classroom for the given session date (Available only for Classroom courses)"},"webinar_tool":{"type":"string","description":"Webinar tool where the session will take place (available only for Webinar and New ILT courses). It is null for onsite events"},"timezone":{"type":"string","description":"Timezone of this session's date"},"gmt":{"type":"string","description":"Timezone offset of this session's date"},"duration":{"type":"integer","description":"(Webinar only) Effective duration of the session date in minutes"},"effective_duration":{"type":"integer","description":"(Classroom only) Effective duration of the session date in minutes"},"id_date":{"type":"integer","description":"(New ILT only) ID of the date"},"collaboration_tool":{"type":"string","description":"(New ILT only) Name of the collaboration tool used"},"is_instructor":{"type":"boolean","description":"(New ILT only) Flag if the current user is instructor for this event"},"is_qr_attendance_enabled":{"type":"boolean","description":"Indicates if attendance via qr code is enabled for this event"},"is_qr_attendance_geolocation_enabled":{"type":"boolean","description":"Indicates if geolocation check is enabled when marking attendance via qr code for this event"},"instructors":{"type":"array","description":"(New ILT only) Array containing the instructor list for this date","items":{"$ref":"#/definitions/LearnCourseViewInstructorsL3"}}}},"LearnCourseViewInstructorsL3":{"required":["firstname","lastname","username"],"properties":{"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"}}},"LearnCourseViewLocations":{"required":["id_location","name","name_country"],"properties":{"id_location":{"type":"integer","description":"The unique identifier of the location"},"name":{"type":"string","description":"The name of the location"},"address":{"type":"string","description":"The address of the location"},"id_country":{"type":"integer","description":"The unique identifier of the country"},"name_country":{"type":"string","description":"The name of the country of the location"},"telephone":{"type":"string","description":"The telephone of the location"},"email":{"type":"string","description":"The email of the location"},"reaching_info":{"type":"string","description":"Reaching location information"},"accommodation":{"type":"string","description":"Accomodation information for the location, e.g. nearby hotels"},"iso_code_country":{"type":"string","description":"The iso code of the country e.g IT"},"id_zone":{"type":"integer","description":"The zone id of the location"},"other_info":{"type":"string","description":"Other extra information, as entered by the administrator while creating this location"}}},"LearnCourseViewAdditionalFieldsL2":{"required":["id","title","type","visible_to_user","value"],"properties":{"id":{"type":"integer","description":"The ID of the field"},"title":{"type":"string","description":"The name of the field"},"type":{"description":"The type of the additional field","enum":["date","dropdown","textfield","textarea"],"type":"string"},"visible_to_user":{"type":"boolean","description":"Whether the field is visible or not to the user"},"mandatory":{"type":"boolean","description":"Whether the field is mandatory or not."},"value":{"type":"string","description":"The value of the field"}}},"LearnCourseViewTree":{"required":["id","name","slug_name","duration","status","is_folder","short_description","params","params_inherited","is_end_object","level"],"properties":{"id":{"type":"string","description":"The internal ID of the folder or LO"},"resource_id":{"type":"string","description":"The internal resource ID of the LO"},"name":{"type":"string","description":"Learning object or folder name"},"id_scorm_item":{"type":"string","description":"The ID of the SCORM chapter (aka SCO)"},"id_aicc_item":{"type":"string","description":"The ID of the AICC chapter"},"slug_name":{"type":"string","description":"Learning object or folder slug name"},"provider":{"type":"integer","description":"Provider id of the training material. If not set, the value is 0."},"description":{"type":"string","description":"Learning object description. Not present for folders"},"type":{"description":"The type of the learning object. Not present for folders. The "dli" type is only available when RELEASE/WEEKLY/DLI-AS-TRAINING-MATERIAL toggle is ON.","enum":["scormorg","test","poll","item","video","htmlpage","tincan","file","authoring","deliverable","aicc","elucidat","centralrepo","lectora","dli","ai_lesson"],"type":"string"},"lti_version":{"description":"The version of the learning object returned only if it's of type LTI and toggle RELEASE/WEEKLY/LTI-ADVANTAGE-13 is ON.","enum":["LTI-1p0","LTI-1p3"],"type":"string"},"proctoring":{"$ref":"#/definitions/LearnCourseViewProctoringL2","description":"Proctoring settings. Returned only if the training materials are of type test, the Honorlock App is active and the proctoring is enabled for the material"},"thumbnail":{"type":"string","description":"Learning object thumbnail URL. Not present for folders"},"duration":{"type":"integer","description":"Learning object duration. Not present for folders"},"status":{"description":"The current status of the user for this chapter. The "proctoring_finalization", "proctoring_review_needed" and "proctoring_invalid" statuses are only available when the training material is of type "test" and the proctoring is enabled for the material. The value is empty string for folders.","enum":["completed","failed","not_started","ab-initio","incomplete","in_progress","proctoring_finalization","proctoring_review_needed","proctoring_invalid"],"type":"string"},"locked":{"description":"The reason why the learning object is locked","enum":["locked","locked_maxattempts","max_number_views"],"type":"string"},"is_folder":{"type":"boolean","description":"Whatever or not the current item is folder or Learning Object"},"short_description":{"type":"string","description":"Learning Object short description. Not present for folders"},"children":{"type":"array","description":"The child subfolders and learning objects of this folder, infinite levels deep, following the same structure","items":{"type":"object"}},"mobile_unsupported":{"type":"boolean","description":"Flag if the LO (SCORM currently only) is not supported by mobile devices"},"tags":{"type":"array","description":"Array with tags linked to this learning object","items":{"type":"string"}},"params":{"type":"string","description":"JSON encoded presentation params"},"params_inherited":{"type":"string","description":"JSON encoded inherited presentation params from CLOR"},"is_end_object":{"type":"boolean","description":"Flag if given LO is marked as End Object Marker"},"level":{"type":"integer","description":"The level of the LO in the tree structure."}}},"LearnCourseViewProctoringL2":{"required":["config_id","test_config_id"],"properties":{"config_id":{"type":"integer","description":"Proctoring tool configuration ID"},"test_config_id":{"type":"integer","description":"Proctoring test configuration ID"}}},"LearnCourseViewCategory":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"ID of course category"},"name":{"type":"string","description":"Name of course category"}}},"LearnCourseViewEcommerce":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The price from the external pricing system"},"discounted_price":{"type":"string","description":"The discounted price from the external pricing system"},"currency":{"type":"string","description":"The currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The currency from the external pricing system"},"alternative_purchase_options":{"$ref":"#/definitions/LearnCourseViewAlternativePurchaseOptions","description":""}},"required":["price","currency","currency_symbol","currency_extended_name"]},"LearnCourseViewAlternativePurchaseOptions":{"properties":{"subscription_plans_resume_page_url":{"type":"string","description":"The redirect url as alternative purchase"}}},"LearnCourseViewCertification":{"required":["id","code","name"],"properties":{"id":{"type":"integer","description":"The certification's ID"},"code":{"type":"string","description":"The certification's code"},"name":{"type":"string","description":"The certification's name"}}},"LearnCourseViewCertificationAward":{"required":["id","issued_at","expiring_at","renewal","renewal_options"],"properties":{"id":{"type":"integer","description":"The awarded certification's ID"},"issued_at":{"type":"string","description":"The awarded certification's issue date"},"expiring_at":{"type":"string","description":"The awarded certification's expiring date (null if it never expires)"},"renewal":{"$ref":"#/definitions/LearnCourseViewRenewal","description":"Certification renewal state"},"renewal_options":{"$ref":"#/definitions/LearnCourseViewRenewalOptions","description":"Certification renewability state"}}},"LearnCourseViewRenewal":{"required":["started","started_at"],"properties":{"started":{"type":"boolean","description":"A flag that inform if the certification renewal is started"},"started_at":{"type":"string","description":"datetime of the renewal start (if renewal is started multiple times, it tracks the first start)"}}},"LearnCourseViewRenewalOptions":{"required":["this_resource","other_resources"],"properties":{"this_resource":{"type":"boolean","description":"if the certification can be renewed by this learning plan"},"other_resources":{"type":"boolean","description":"if the certification can be renewed by other resources than this learning plan"}}},"LearnCourseViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseViewLast","description":"Link to the last page"}}},"LearnCourseViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseLosResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseLosData","description":"List of learning objects/chapters in the course"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseLosLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseLosData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of learning objects/chapters","items":{"$ref":"#/definitions/LearnCourseLosItems"}}}},"LearnCourseLosItems":{"required":["id_org","item_id","id_parent","title","object_type","id_resource","status"],"properties":{"id_org":{"type":"integer","description":"Learning object id"},"item_id":{"type":"integer","description":"Learning scorm or aicc item id from items table"},"id_parent":{"type":"integer","description":"Parent id"},"title":{"type":"string","description":"Learning object/chapter title"},"object_type":{"type":"string","description":"Learning object/chapter type, possible values (scormorg|item|video|tincan|file|htmlpage|test|poll|file|authoring|deliverable|aicc|elucidat|centralrepo|lectora)"},"id_resource":{"type":"integer","description":"Id in resource table"},"status":{"type":"string","description":"Learning object/chapter status for the caller user, possible values (completed|passed|ab-initio|attempted|not attempted|incomplete|failed)"}}},"LearnCourseLosLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseLosSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseLosGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseLosFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseLosLast","description":"Link to the last page"}}},"LearnCourseLosSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseLosGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseLosFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseLosLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseDeeplinkSchema":{"type":"object","required":["hash","generated_by"],"properties":{"hash":{"type":"string","description":"Generate HASH of the deeplink to be validated"},"generated_by":{"type":"integer","description":"ID of the user that generates this HASH"}}},"LearnCourseDeeplinkResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseDeeplinkData","description":"Success or failure to find course"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseDeeplinkLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseDeeplinkData":{"required":["message","redirectUrl","success"],"properties":{"message":{"type":"string","description":"Message of the operation"},"redirectUrl":{"type":"string","description":"URL of the direct link"},"success":{"type":"boolean","description":"Status of the operation"}}},"LearnCourseDeeplinkLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseDeeplinkSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseDeeplinkGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseDeeplinkFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseDeeplinkLast","description":"Link to the last page"}}},"LearnCourseDeeplinkSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseDeeplinkGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseDeeplinkFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseDeeplinkLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseSessionDeeplinkSchema":{"type":"object","required":["hash","generated_by"],"properties":{"hash":{"type":"string","description":"HASH of the deeplink for validation"},"generated_by":{"type":"integer","description":"ID of the user that generated this link"}}},"LearnCourseSessionDeeplinkResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseSessionDeeplinkData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseSessionDeeplinkData":{"required":["message","redirectUrl","success"],"properties":{"message":{"type":"string","description":"Message of the operation"},"redirectUrl":{"type":"string","description":"URL of the direct link"},"success":{"type":"boolean","description":"Status of the operation"},"action":{"description":"Action the frontend should perform","enum":["toast","toast_neutral","change_session"],"type":"string"}}},"LearnCourseSessionsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseSessionsData","description":"API response of course sessions"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseSessionsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseSessionsData":{"required":["sessions","current_location","additional_fields"],"properties":{"sessions":{"type":"array","description":"Array of course sessions. Indexed by the unique ID of the session","items":{"$ref":"#/definitions/LearnCourseSessionsSessions"}},"evaluation":{"$ref":"#/definitions/LearnCourseSessionsEvaluation","description":"Session evaluation object"},"comment":{"type":"string","description":"Full evaluation message left by the instructor"},"score":{"type":"number","format":"float","description":"The score given by the instructor"},"evaluation_status":{"type":"boolean","description":"The final evaluation status (true = passed, false = failed)"},"evaluation_attachment":{"$ref":"#/definitions/LearnCourseSessionsEvaluationAttachment","description":"The UTC datetime of when the evaluation was created"},"current_location":{"type":"integer","description":"The location to be displayed when viewing the session. If there are different locations for the different dates, then this returns -1"},"is_enrolled":{"type":"boolean","description":"If the user is enrolled in this session"},"locations":{"type":"array","description":"(Classroom only) An array of all locations used throughout the sessions and dates of this course","items":{"$ref":"#/definitions/LearnCourseSessionsLocations"}},"classrooms":{"type":"array","description":"(Classroom only) An array of all classrooms available within the sessions of this course","items":{"$ref":"#/definitions/LearnCourseSessionsClassrooms"}},"additional_fields":{"type":"array","description":"An array of all additional session fields","items":{"$ref":"#/definitions/LearnCourseSessionsAdditionalFields"}}}},"LearnCourseSessionsSessions":{"required":["id","name","slug_name","start_date","end_date","can_manage","evaluation_type","score_base","dates"],"properties":{"id":{"type":"integer","description":"The unique identifier 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":"The session name"},"description":{"type":"string","description":"The description of the session for webinars or "Other info" for classrooms"},"slug_name":{"type":"string","description":"The SEO version of the session's name"},"start_date":{"type":"string","format":"date","description":"The UTC start datetime for the session"},"end_date":{"type":"string","format":"date","description":"The end date of the latest date within this session, in the date's local timezone"},"begin_day":{"type":"string","format":"date","description":"The start date of the earliest date within this session, in the date's local timezone"},"begin_time":{"type":"string","description":"The start time of the earliest date within this session, in the date's local timezone"},"begin_timezone":{"type":"string","description":"The timezone of the earliest available date within the session. E.g. "Europe/Rome""},"end_time":{"type":"string","description":"The end time of the latest date within this session, in the date's local timezone"},"end_timezone":{"type":"string","description":"The timezone of the latest available date within the session. E.g. "Europe/Rome""},"min_dates_for_completion":{"type":"integer","description":"(New ILT only) If webinar settings require completing a minimum number of dates, this param provides such a number"},"can_manage":{"type":"boolean","description":"Can current user manage this session"},"evaluation_type":{"type":"string","description":"Evaluation type: 0=>manual, 1=> online test"},"is_instructor":{"type":"boolean","description":"(New ILT only) Flag if the current user is instructor for this event"},"score_base":{"type":"string","description":"Evaluation score base"},"instructors":{"type":"array","description":"(New ILT only) Array containing the instructor list for this session","items":{"$ref":"#/definitions/LearnCourseSessionsInstructors"}},"dates":{"type":"array","description":"Array of the session's dates","items":{"$ref":"#/definitions/LearnCourseSessionsDates"}}}},"LearnCourseSessionsInstructors":{"required":["firstname","lastname","username"],"properties":{"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"}}},"LearnCourseSessionsDates":{"required":["day","name","timezone","allowed_api_link","allowed_api_grab","user_status","effective_duration","webinar_tool_sync_failed"],"properties":{"day":{"type":"string","format":"date","description":"UTC date of this session's date"},"name":{"type":"string","description":"Name of this session's date"},"description":{"type":"string","description":"(New ILT only) Description of this session's date"},"start_hour":{"type":"string","description":"(Webinar only) Starting hour of this session's date"},"join_in_advance_user":{"type":"integer","description":"(New ILT only) A period of time (in minutes) before the starting time when the user can join in advance"},"join_in_advance_instructor":{"type":"integer","description":"(New ILT only) A period of time (in minutes) before the starting time when the instructor/teacher can join in advance"},"duration":{"type":"integer","description":"(Webinar only) Duration (in minutes) of this session's date"},"time_begin":{"type":"string","description":"(Classroom only and New ILT only) Starting hour of this session's date"},"time_end":{"type":"string","description":"(Classroom only and New ILT only) Ending hour of this session's date"},"timezone":{"type":"string","description":"Timezone offset of this session's date"},"tool":{"type":"string","description":"(Webinar only and New ILT only) The webinar tool name used for this session's date"},"tool_mapping_field_lms":{"type":"string","description":"(New ILT only) The filed which will be used for mapping the user's attendance . Works only if Adobe toggles are rurned on ."},"webinar_tool":{"type":"string","description":"(New ILT only) The webinar tool identifier used for this session's date"},"collaboration_tool":{"type":"string","description":"(New ILT only) The collaboration tool used for this session's date"},"allowed_api_link":{"type":"boolean","description":"If the webinar tool allows to recieve an external link for the webinar recording"},"allowed_api_grab":{"type":"boolean","description":"If the webinar tool allows to recieve an external file for the webinar recording"},"url":{"type":"string","description":"(New ILT only) Custom URL. Only shown if the tool is "Custom""},"has_recording":{"type":"boolean","description":"(New ILT only) If the webinar has training materials records then has_recording = 1 else it is 0"},"recording_status":{"type":"integer","description":"(ILT only) The upload status for the recording (a number between 0 and 5, 0 => No recording, 1 => In Download, 2 => In Upload, 3 => In Conversion, 4 => Failed, 5 => Completed)"},"id_location":{"type":"integer","description":"(Classroom only and New ILT only) Location identifier of this session's date"},"id_classroom":{"type":"integer","description":"(Classroom only and New ILT only) Classroom identifier of this session's date"},"instructors":{"type":"array","description":"(New ILT only) Array containing the instructor list for this event","items":{"$ref":"#/definitions/LearnCourseSessionsInstructorsL2"}},"user_status":{"type":"string","description":"Status of the user inside of this session's date. For classroom - "attended", "not_attended". For webinar - "upcoming", "not_attended", "attended"."},"effective_duration":{"type":"integer","description":"(Classroom only and New ILT only) Duration (in minutes) of this session's date"},"id":{"type":"integer","description":"(New ILT only) Internal ID of the event"},"is_instructor":{"type":"boolean","description":"(New ILT only) Flag if the current user is instructor for this event"},"webinar_tool_sync_failed":{"type":"boolean","description":"Check if the webinar tool is synced"},"is_qr_attendance_enabled":{"type":"boolean","description":"Indicates if attendance via qr code is enabled for this event"},"is_qr_attendance_geolocation_enabled":{"type":"boolean","description":"Indicates if geolocation check is enabled when marking attendance via qr code for this event"}}},"LearnCourseSessionsInstructorsL2":{"required":["firstname","lastname","username"],"properties":{"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"}}},"LearnCourseSessionsEvaluation":{"properties":{"evaluation_date":{"type":"string","format":"date","description":"The UTC datetime of when the evaluation was created"},"evaluator":{"$ref":"#/definitions/LearnCourseSessionsEvaluator","description":"Information about the instructor that evaluated the learner"}}},"LearnCourseSessionsEvaluator":{"required":["username","firstname","lastname","avatar"],"properties":{"username":{"type":"string","description":"The username of the instructor that evaluated the learner"},"firstname":{"type":"string","description":"The firstname of the instructor that evaluated the learner"},"lastname":{"type":"string","description":"The lastname of the instructor that evaluated the learner"},"avatar":{"type":"string","description":"The URL of the avatar of the instructor that evaluated the learner"}}},"LearnCourseSessionsEvaluationAttachment":{"required":["url","name"],"properties":{"url":{"type":"string","description":"URL of the attachment file"},"name":{"type":"string","description":"Filename to be displayed"}}},"LearnCourseSessionsLocations":{"required":["name","country_name"],"properties":{"name":{"type":"string","description":"The name of the location"},"address":{"type":"string","description":"The address of the location"},"country_name":{"type":"string","description":"The name of the country of the location"},"telephone":{"type":"string","description":"The telephone of the location"},"email":{"type":"string","description":"The email of the location"},"directions_info":{"type":"string","description":"Directions on how to reach the location"},"accommodation":{"type":"string","description":"Accomodation information for the location, e.g. nearby hotels"},"other_info":{"type":"string","description":"Other extra information, as entered by the administrator while creating this location"},"photos":{"type":"array","description":"Optional photos of the location","items":{"$ref":"#/definitions/LearnCourseSessionsPhotos"}}}},"LearnCourseSessionsPhotos":{"required":["url"],"properties":{"url":{"type":"string","description":"URL of the photo"},"description":{"type":"string","description":"Caption of the photo"}}},"LearnCourseSessionsClassrooms":{"required":["name","seats","id_location"],"properties":{"name":{"type":"string","description":"The name of the classroom"},"details":{"type":"string","description":"Extra details about the building where this classroom is located"},"seats":{"type":"integer","description":"How many seats are there in this classroom. Zero value means unspecified seats amount."},"equipment":{"type":"string","description":"Describes the available equipment, available within this classroom"},"id_location":{"type":"integer","description":"The internal ID of the location, where this Classroom is located"}}},"LearnCourseSessionsAdditionalFields":{"required":["id","title","type","visible_to_user","value"],"properties":{"id":{"type":"integer","description":"The ID of the field"},"title":{"type":"string","description":"The name of the field"},"type":{"description":"The type of the additional field","enum":["date","dropdown","textfield","textarea"],"type":"string"},"visible_to_user":{"type":"boolean","description":"Whether the field is visible or not to the user"},"value":{"type":"string","description":"The value of the field"}}},"LearnCourseSessionsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseSessionsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseSessionsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseSessionsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseSessionsLast","description":"Link to the last page"}}},"LearnCourseSessionsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseSessionsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseSessionsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseSessionsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseRatingResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseRatingData","description":"Information about the rating of the given course"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseRatingLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseRatingData":{"required":["average_rating"],"properties":{"average_rating":{"type":"number","format":"float","description":"The average rating for this course"}}},"LearnCourseRatingLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseRatingSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseRatingGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseRatingFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseRatingLast","description":"Link to the last page"}}},"LearnCourseRatingSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseRatingGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseRatingFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseRatingLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseUpdateRatingSchema":{"type":"object","required":["rating"],"properties":{"rating":{"type":"integer","description":"Rating value (Number between 0 and 5)"}}},"LearnCourseUpdateRatingResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseUpdateRatingData","description":"Saving of the course rating information"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseUpdateRatingLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseUpdateRatingData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success of failure"}}},"LearnCourseUpdateRatingLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseUpdateRatingSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseUpdateRatingGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseUpdateRatingFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseUpdateRatingLast","description":"Link to the last page"}}},"LearnCourseUpdateRatingSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseUpdateRatingGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseUpdateRatingFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseUpdateRatingLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseReportResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseReportData","description":"Statistics for course enrollments"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseReportLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS. Due to the specifics of the programming language, this attribute can be returned as empty array when there is no pagination."}}},"LearnCourseReportData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Items of the report","items":{"$ref":"#/definitions/LearnCourseReportItems"}},"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. The attribute value can be null."},"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"},"query_id":{"type":"string","description":"The ID of the query"},"next_token":{"type":"string","description":"The token to recover the next chunk of data"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/LearnCourseReportSort"}}}},"LearnCourseReportItems":{"properties":{"username":{"type":"string","description":"Username of the enrolled user. Returned only when idCourse parameter is provided and its value is an id of existing course."},"first_name":{"type":"string","description":"First name of the enrolled user. Returned only when idCourse parameter is provided and its value is an id of existing course."},"last_name":{"type":"string","description":"Last name of the enrolled user. Returned only when idCourse parameter is provided and its value is an id of existing course."},"status":{"type":"string","description":"Status of the enrolled user in the course. Returned only when idCourse parameter is provided and its value is an id of existing course."},"enrollment_date":{"type":"string","format":"date","description":"Date of the enrollment. Returned only when idCourse parameter is provided and its value is an id of existing course."},"time_in_course":{"type":"string","description":"Time in seconds that user has been in this course. Returned only when idCourse parameter is provided and its value is an id of existing course."},"last_access":{"type":"string","format":"date","description":"Last access date in this course. Returned only when idCourse parameter is provided and its value is an id of existing course."},"completion_date":{"type":"string","format":"date","description":"Completion date of the course. Returned only when idCourse parameter is provided and its value is an id of existing course."},"score":{"type":"string","description":"Given score in the course. Returned only when idCourse parameter is provided and its value is an id of existing course."},"idCourse":{"type":"string","description":"ID of the course. Returned only when idCourse parameter is not provided."},"code":{"type":"string","description":"Code of the course. Returned only when idCourse parameter is not provided."},"name":{"type":"string","description":"Name of the course. Returned only when idCourse parameter is not provided."},"type":{"description":"Type of the course. Returned only when idCourse parameter is not provided.","enum":["elearning","classroom"],"type":"string"},"has_esignature_enabled":{"type":"boolean","description":"If the course has ESignature enabled. Returned only when idCourse parameter is not provided."},"enrolled":{"type":"string","description":"Number of the enrolled users in this course. Returned only when idCourse parameter is not provided."},"completed":{"type":"string","description":"Number of the users that completed this course. Returned only when idCourse parameter is not provided."},"in_progress":{"type":"string","description":"Number of the users that are in progress in this course. Returned only when idCourse parameter is not provided."},"not_started":{"type":"string","description":"Number of the users that still not started this course. Returned only when idCourse parameter is not provided."}}},"LearnCourseReportSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnCourseReportLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseReportSelf","description":"Link to the current page"},"next":{"$ref":"#/definitions/LearnCourseReportNext","description":"Go to next page number"},"prev":{"$ref":"#/definitions/LearnCourseReportPrev","description":"Go to previous page number"},"goto":{"$ref":"#/definitions/LearnCourseReportGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseReportFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseReportLast","description":"Link to the last page"}}},"LearnCourseReportSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseReportNext":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the next page"}}},"LearnCourseReportPrev":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the previous page"}}},"LearnCourseReportGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseReportFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseReportLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseWidgetsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseWidgetsData","description":"List of widgets in the course"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseWidgetsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseWidgetsData":{"required":["widgets"],"properties":{"widgets":{"type":"array","description":"Array of course widgets.","items":{"$ref":"#/definitions/LearnCourseWidgetsWidgets"}}}},"LearnCourseWidgetsWidgets":{"required":["id","title","content_type","display_type","position","columns_span","params"],"properties":{"id":{"type":"integer","description":"The unique identifier of the widget"},"title":{"type":"string","description":"The title of the widget"},"content_type":{"type":"string","description":"The widget type: "coursedesc" | "comments" | "coursedocs" | "forum" | "myinstructor" | "lpnavigation" | "videoconf""},"display_type":{"description":"The display mode of the widget","enum":["admin","learner"],"type":"string"},"position":{"type":"integer","description":"Widget sort id"},"columns_span":{"type":"integer","description":"Widget width in columns"},"params":{"type":"string","description":"set of parameter for the widget to load (defined at widget creation time)"}}},"LearnCourseWidgetsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseWidgetsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseWidgetsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseWidgetsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseWidgetsLast","description":"Link to the last page"}}},"LearnCourseWidgetsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseWidgetsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseWidgetsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseWidgetsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseCommentsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"List of threads/comments in the course","items":{"$ref":"#/definitions/LearnCourseCommentsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseCommentsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseCommentsData":{"properties":{"discussions_count":{"type":"integer","description":"Number of discussions"},"items":{"type":"array","description":"Threads in the forum","items":{"$ref":"#/definitions/LearnCourseCommentsItems"}}},"required":["items"]},"LearnCourseCommentsItems":{"required":["type","metadata"],"properties":{"type":{"type":"integer","description":"Type of the Threads"},"metadata":{"$ref":"#/definitions/LearnCourseCommentsMetadata","description":"Threads meta information"}}},"LearnCourseCommentsMetadata":{"required":["id","title","owner","sub_items","tags","last"],"properties":{"id":{"type":"integer","description":"ID of the Thread"},"title":{"type":"string","description":"Content of the Thread"},"owner":{"$ref":"#/definitions/LearnCourseCommentsOwner","description":"Owner of the Thread"},"sub_items":{"type":"array","description":"Post in this Thread","items":{"$ref":"#/definitions/LearnCourseCommentsSubItems"}},"tags":{"type":"array","description":"Tags in the thread","items":{"type":"string"}},"last":{"$ref":"#/definitions/LearnCourseCommentsLast","description":"Last started thread in the forum"}}},"LearnCourseCommentsOwner":{"required":["id","full_name","avatar","short_name","is_expert"],"properties":{"id":{"type":"integer","description":"ID of the user"},"full_name":{"type":"string","description":"Full name of the user"},"avatar":{"type":"string","description":"Avatar URL of the user"},"short_name":{"type":"string","description":"User initials"},"is_expert":{"type":"boolean","description":"Is user expert"}}},"LearnCourseCommentsSubItems":{"required":["type","id","title","is_best","read_only","created_at","rating","owner"],"properties":{"type":{"type":"integer","description":"Type of the post"},"id":{"type":"integer","description":"ID of the post"},"title":{"type":"string","description":"Text of the post,"},"is_best":{"type":"boolean","description":"Flag if the post is marked as "BEST""},"read_only":{"type":"boolean","description":"Flag if the current user is allowed to view this post"},"created_at":{"type":"string","description":"Date of post creation"},"rating":{"$ref":"#/definitions/LearnCourseCommentsRating","description":"Rating status"},"owner":{"$ref":"#/definitions/LearnCourseCommentsOwnerL2","description":"Owner of the Thread"}}},"LearnCourseCommentsRating":{"required":["like","dislike","likes","dislikes"],"properties":{"like":{"type":"integer","description":"Number of likes reactions"},"dislike":{"type":"integer","description":"Number of dislikes reactions"},"likes":{"type":"integer","description":"Number of likes of the message"},"dislikes":{"type":"integer","description":"Number of likes of the message"}}},"LearnCourseCommentsOwnerL2":{"required":["id","full_name","avatar","short_name","is_expert"],"properties":{"id":{"type":"integer","description":"ID of the user"},"full_name":{"type":"string","description":"Full name of the user"},"avatar":{"type":"string","description":"Avatar URL of the user"},"short_name":{"type":"string","description":"User initials"},"is_expert":{"type":"boolean","description":"Is user expert"}}},"LearnCourseCommentsLast":{"required":["type","id","title","is_best","read_only","created_at","rating","owner"],"properties":{"type":{"type":"integer","description":"Type of the post"},"id":{"type":"integer","description":"ID of the post"},"title":{"type":"string","description":"Text of the post,"},"is_best":{"type":"boolean","description":"Flag if the post is marked as "BEST""},"read_only":{"type":"boolean","description":"Flag if the current user is allowed to view this post"},"created_at":{"type":"string","description":"Date of post creation"},"rating":{"$ref":"#/definitions/LearnCourseCommentsRatingL2","description":"Rating status"},"owner":{"$ref":"#/definitions/LearnCourseCommentsOwnerL3","description":"Owner of the Thread"}}},"LearnCourseCommentsRatingL2":{"required":["like","dislike","likes","dislikes"],"properties":{"like":{"type":"integer","description":"Number of likes reactions"},"dislike":{"type":"integer","description":"Number of dislikes reactions"},"likes":{"type":"integer","description":"Number of likes of the message"},"dislikes":{"type":"integer","description":"Number of likes of the message"}}},"LearnCourseCommentsOwnerL3":{"required":["id","full_name","avatar","short_name","is_expert"],"properties":{"id":{"type":"integer","description":"ID of the user"},"full_name":{"type":"string","description":"Full name of the user"},"avatar":{"type":"string","description":"Avatar URL of the user"},"short_name":{"type":"string","description":"User initials"},"is_expert":{"type":"boolean","description":"Is user expert"}}},"LearnCourseCommentsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseCommentsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseCommentsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseCommentsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseCommentsLastL2","description":"Link to the last page"}}},"LearnCourseCommentsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseCommentsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseCommentsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseCommentsLastL2":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseThreadSchema":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The text of the message"},"forum_id":{"type":"integer","description":"The id of the forum"}}},"LearnCourseThreadResponse":{"required":["output","version"],"properties":{"output":{"$ref":"#/definitions/LearnCourseThreadOutput","description":"The output"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseThreadOutput":{},"LearnCourseMessageSchema":{"type":"object","required":["content"],"properties":{"content":{"type":"string","description":"The text of the message"}}},"LearnCourseMessageResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseMessageData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseMessageLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseMessageData":{"properties":{"type":{"type":"integer","description":"Message type"},"id":{"type":"integer","description":"Message ID"},"title":{"type":"string","description":"Message text"},"is_best":{"type":"boolean","description":"Flag if the message is marked as BEST"},"read_only":{"type":"boolean","description":"Flag if the current user is allowed to view this message"},"create_at":{"type":"string","format":"date","description":"Creation date of the message"},"rating":{"$ref":"#/definitions/LearnCourseMessageRating","description":"Rating information of the message"},"owner":{"$ref":"#/definitions/LearnCourseMessageOwner","description":"Information about the owner of the message"},"messageSave":{"type":"string","description":"Status of the operation"}}},"LearnCourseMessageRating":{"required":["likes","dislike"],"properties":{"likes":{"type":"integer","description":"Likes of the message"},"dislike":{"type":"integer","description":"Dislikes of the message"}}},"LearnCourseMessageOwner":{"required":["id","short_name","full_name","avatar","is_expert"],"properties":{"id":{"type":"integer","description":"ID of the user"},"short_name":{"type":"string","description":"User initials"},"full_name":{"type":"string","description":"Full name of the user"},"avatar":{"type":"string","description":"Avatar URL of the user"},"is_expert":{"type":"boolean","description":"Flag if the user is expert"}}},"LearnCourseMessageLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseMessageSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseMessageGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseMessageFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseMessageLast","description":"Link to the last page"}}},"LearnCourseMessageSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseMessageGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseMessageFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseMessageLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseThumbForumMessageResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseThumbForumMessageData","description":"Thumbs"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseThumbForumMessageLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseThumbForumMessageData":{"required":["result","rating"],"properties":{"result":{"type":"boolean","description":"Whether or not the action was processed"},"rating":{"$ref":"#/definitions/LearnCourseThumbForumMessageRating","description":""}}},"LearnCourseThumbForumMessageRating":{"required":["likes","dislikes"],"properties":{"likes":{"type":"integer","description":""},"dislikes":{"type":"integer","description":""}}},"LearnCourseThumbForumMessageLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseThumbForumMessageSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseThumbForumMessageGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseThumbForumMessageFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseThumbForumMessageLast","description":"Link to the last page"}}},"LearnCourseThumbForumMessageSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseThumbForumMessageGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseThumbForumMessageFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseThumbForumMessageLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseChartResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseChartData","description":"Statistics for course enrollments"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseChartLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseChartData":{"properties":{"title":{"type":"string","description":"Title of the course"},"code":{"type":"string","description":"Code of the course"},"description":{"type":"string","description":"Description of the course"},"partecipation":{"$ref":"#/definitions/LearnCourseChartPartecipation","description":"Top courses by number of enrollments"},"summary":{"$ref":"#/definitions/LearnCourseChartSummary","description":"Summary for courses - enrollments and enrollment statuses"},"completion":{"$ref":"#/definitions/LearnCourseChartCompletion","description":"Courses completion grouped by date"}},"required":["partecipation","summary","completion"]},"LearnCourseChartPartecipation":{},"LearnCourseChartSummary":{},"LearnCourseChartCompletion":{},"LearnCourseChartLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseChartSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseChartGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseChartFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseChartLast","description":"Link to the last page"}}},"LearnCourseChartSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseChartGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseChartFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseChartLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseEnrollmentPdfSchema":{"type":"object","properties":{"timeframe":{"description":"Timeframe type, default: any","enum":["any","this_year","this_week","this_month","custom"],"type":"string"},"startDate":{"type":"string","format":"date","description":"Start date which should be used for the filtering. The expected format is "2023-01-31""},"endDate":{"type":"string","format":"date","description":"End date which should be used for the filtering. The expected format is "2023-01-31""},"hide_deactivated_users":{"type":"boolean","description":"Exclude inactive users"},"branchId":{"type":"integer","description":"Branch to filter the results by"},"idCourse":{"type":"integer","description":"Course to filter the results by"},"image1":{"type":"string","description":"Image of Chart 1 encoded in the base64 format"},"image2":{"type":"string","description":"Image of Chart 2 encoded in the base64 format"}}},"LearnCourseEnrollmentPdfResponse":{"required":["file","version"],"properties":{"file":{"type":"string","description":"The generated pdf"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseCourseIltsessionResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseCourseIltsessionData","description":"Success or failure to find course session"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseCourseIltsessionLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseCourseIltsessionData":{"properties":{"name":{"type":"string","description":"The name of the session"},"maximum_enrollments":{"type":"integer","description":"Maximum enrollments in the session"},"minimum_enrollments":{"type":"integer","description":"Minimum enrollments in the session"},"start_date":{"type":"string","format":"date","description":"Session Start date (in UTC)"},"end_date":{"type":"string","format":"date","description":"Session End date (in UTC)"},"other_info":{"type":"string","description":"Session other info"},"last_subscription_date":{"type":"string","format":"date","description":"Last subscription date for this session"},"total_hours":{"type":"integer","description":"Session duration time"},"evaluation_type":{"type":"integer","description":"Evaluation type: 0 => Manual, 1 => Online test"},"evaluation_base_score":{"type":"integer","description":"Base score for the evaluation (applicable only if evaluation_mode = 0)"},"evaluation_mode":{"type":"integer","description":"Session Evaluation mode"},"session_dates":{"type":"array","description":"The dates of the session","items":{"$ref":"#/definitions/LearnCourseCourseIltsessionSessionDates"}},"additional_fields":{"type":"array","description":"An array of all additional session fields","items":{"$ref":"#/definitions/LearnCourseCourseIltsessionAdditionalFields"}}},"required":["maximum_enrollments","start_date","end_date","total_hours","evaluation_mode","additional_fields"]},"LearnCourseCourseIltsessionSessionDates":{"properties":{"name":{"type":"string","description":"Session date name"},"day":{"type":"string","format":"date","description":"Session date day"},"time_begin":{"type":"string","format":"date","description":"The time session begins"},"time_end":{"type":"string","format":"date","description":"The time session ends"},"break_begin":{"type":"string","format":"date","description":"The session break time begin"},"break_end":{"type":"string","format":"date","description":"The session break time end"},"timezone":{"type":"string","description":"The session timezone"},"classroom_id":{"type":"integer","description":"The session classroom id"},"location_id":{"type":"integer","description":"The session location id"},"effective_duration":{"type":"integer","description":"Duration (in minutes) of this session's date"}},"required":["day","time_begin","time_end","timezone"]},"LearnCourseCourseIltsessionAdditionalFields":{"required":["id","title","type","visible_to_user","value","mandatory","settings"],"properties":{"id":{"type":"string","description":"The ID of the field"},"title":{"type":"string","description":"The name of the field"},"type":{"description":"The type of the additional field","enum":["date","dropdown","textfield","textarea"],"type":"string"},"visible_to_user":{"type":"string","description":"Whether the field is visible or not to the user. It could be "0" or "1""},"value":{"type":"string","description":"The value of the field"},"mandatory":{"type":"string","description":"If the field is mandatory. It could be "0" or "1""},"settings":{"type":"string","description":"JSON settings"}}},"LearnCourseCourseIltsessionLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseCourseIltsessionSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseCourseIltsessionGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseCourseIltsessionFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseCourseIltsessionLast","description":"Link to the last page"}}},"LearnCourseCourseIltsessionSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseCourseIltsessionGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseCourseIltsessionFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseCourseIltsessionLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseSwitchSessionsSchema":{"type":"object","required":["course_id","old_session_id","new_session_id"],"properties":{"course_id":{"type":"integer","description":"Course ID"},"old_session_id":{"type":"integer","description":"Old session ID"},"new_session_id":{"type":"integer","description":"New session ID"}}},"LearnCourseSwitchSessionsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseSwitchSessionsData","description":"Information about status of movement of user from one Session to another one"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseSwitchSessionsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseSwitchSessionsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is successful"}}},"LearnCourseSwitchSessionsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseSwitchSessionsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseSwitchSessionsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseSwitchSessionsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseSwitchSessionsLast","description":"Link to the last page"}}},"LearnCourseSwitchSessionsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseSwitchSessionsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseSwitchSessionsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseSwitchSessionsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseDownloadEvaluationFileResponse":{"required":["file","version"],"properties":{"file":{"type":"string","description":"the file requested is downloaded."},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseAddLosToCourseSchema":{"type":"object","properties":{"folder_key":{"type":"integer","description":"The ID of the target L.O. category into the course (if not specified, the root will be used)"},"version":{"type":"integer","description":"The version of the C.L.O.R. object"}},"required":["version"]},"LearnCourseAddLosToCourseResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseAddLosToCourseData","description":"Success or failure to add CLOR LO into the course, generated LO ID if successful"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseAddLosToCourseLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseAddLosToCourseData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is successful"},"lo_id":{"type":"integer","description":"The ID of the generated learning object into the LMS course"}}},"LearnCourseAddLosToCourseLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseAddLosToCourseSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseAddLosToCourseGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseAddLosToCourseFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseAddLosToCourseLast","description":"Link to the last page"}}},"LearnCourseAddLosToCourseSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseAddLosToCourseGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseAddLosToCourseFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseAddLosToCourseLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseDeleteLosFromCourseResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseDeleteLosFromCourseData","description":"Success or failure to remove LOs from the course"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseDeleteLosFromCourseLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseDeleteLosFromCourseData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Is successful"}}},"LearnCourseDeleteLosFromCourseLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseDeleteLosFromCourseSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseDeleteLosFromCourseGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseDeleteLosFromCourseFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseDeleteLosFromCourseLast","description":"Link to the last page"}}},"LearnCourseDeleteLosFromCourseSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseDeleteLosFromCourseGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseDeleteLosFromCourseFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseDeleteLosFromCourseLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseBatchAddLosToCourseSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"The list of L.O.s to be imported from C.L.O.R. into courses","items":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseItems"}}}},"LearnCourseBatchAddLosToCourseItems":{"required":["course_id","clor_lo_id","version_id"],"properties":{"course_id":{"type":"integer","description":"The ID of the target LMS course"},"clor_lo_id":{"type":"integer","description":"The ID of the learning object in the C.L.O.R."},"folder_key":{"type":"integer","description":"The ID of the target L.O. category into the course (if not specified, the root will be used)"},"version_id":{"type":"integer","description":"The version of the C.L.O.R. object"},"batch_item_id":{"type":"string","description":"A client-generated identifier for the single batch item. Will be returned in output as it is"}}},"LearnCourseBatchAddLosToCourseResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Success or failure to add CLOR LO into the course","items":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseBatchAddLosToCourseData":{"required":["row_index","success","clor_lo_id","course_id"],"properties":{"row_index":{"type":"integer","description":"Import ID for the current record"},"success":{"type":"boolean","description":"Could the record be properly imported?"},"message":{"type":"string","description":"Optional error message"},"clor_lo_id":{"type":"integer","description":"Same as input"},"course_id":{"type":"integer","description":"Same as input"},"lo_id":{"type":"integer","description":"The ID of the generated learning object into the LMS course"}}},"LearnCourseBatchAddLosToCourseLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseBatchAddLosToCourseLast","description":"Link to the last page"}}},"LearnCourseBatchAddLosToCourseSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseBatchAddLosToCourseGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseBatchAddLosToCourseFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseBatchAddLosToCourseLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseBatchImportCoursesSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Associative array containing key/value pairs to be imported","items":{"$ref":"#/definitions/LearnCourseBatchImportCoursesItems"}},"options":{"$ref":"#/definitions/LearnCourseBatchImportCoursesOptions","description":"Object containing additional options."}}},"LearnCourseBatchImportCoursesItems":{"properties":{"course_provider":{"type":"string","description":"The CSP of the course (foreign key - needed only when importing external course from catalogue)"},"external_course_id":{"type":"string","description":"If course_provider is provided, this represent the provider internal id. Ignored otherwise."},"course_code":{"type":"string","description":"The code of the course"},"course_type":{"type":"string","description":"The type of the course (elearning, classroom)"},"course_name":{"type":"string","description":"The name of the course"},"course_description":{"type":"string","description":"The description of the course"},"course_cover":{"type":"string","description":"Course thumbnail encoded in the base64 format."},"course_cover_id":{"type":"integer","description":"Course thumbnail id.Mutually exclusive with course_cover"},"course_cover_name":{"type":"string","description":"Course thumbnail name. The name of an image in S3 (allowed types: jpg, png, gif)"},"course_language":{"type":"string","description":"The language of the course"},"course_published":{"type":"string","description":"Takes one of two values 'published' or 'unpublished'. 'published' is equal to set the course_status param to 2 and 'unpublished' to set it to 0."},"course_category_id":{"type":"integer","description":"The LMS numeric ID of the target category. If provided, will prevail on 'course_category' parameter"},"course_category":{"type":"string","description":"The code of the category of the course"},"course_difficulty":{"type":"string","description":"Takes one of the following values 'veryeasy', 'easy', 'medium', 'difficult', 'verydifficult'"},"user_enroll":{"type":"number","description":"Either 0 or 1, indicates whether to allow self enrollment of the course"},"user_enroll_begin":{"type":"string","description":"The start of the date period during which self enrollment is allowed. Format yyyy-mm-dd"},"user_enroll_end":{"type":"string","description":"The end of the date period during which self enrollment is allowed. Format yyyy-mm-dd"},"course_avg_time":{"type":"string","description":"The average time of the course. Format HH:MM:SS"},"course_for_sale":{"type":"number","description":"Either 0 or 1, indicates whether an elearning course is for sale"},"course_price":{"type":"number","description":"The price of the course in cents of its currency. eg: 100 means the course costs 1"},"course_status":{"type":"number","description":"The status of the course. Takes one of the following values 'In preparation', 'Available', 'Effective'"},"course_credits":{"type":"number","description":"The credits assigned to the course multiplied by 100. eg. 250 indicates 2.5 credits"},"course_max_subscriptions":{"type":"number","description":"The total number of subscriptions allowed in the course"},"course_validity_begin":{"type":"string","description":"The start of the date period during which the course is valid. Format yyyy-mm-dd"},"course_validity_end":{"type":"string","description":"The end of the date period during which the course is valid. Format yyyy-mm-dd"},"xxx":{"type":"string","description":"Multiple additional fields may be added. Simply replace "xxx" with the right field name or with the 'field_yy', where yy is the right field ID. The field name should be written in the default language."},"batch_item_id":{"type":"string","description":"This will be returned as it is in the output. It's not course data, but may be useful in some processes"},"content_partner_code":{"type":"string","description":"Content partner code to associate the content partner. When empty means "no content parnter". Can be associated only active content partners"},"affiliate_price":{"type":"integer","description":"Valid only when there's a content_partner_code defined. When empty it will be automatically calculated based on the default content partner discount. It cannot be higher than affiliate price and it cannot be negative"},"content_partner_fields":{"$ref":"#/definitions/LearnCourseBatchImportCoursesContentPartnerFields","description":"It allows to define the data for the content partner additional fields with type "Customizable for each course""},"decommissioning":{"$ref":"#/definitions/LearnCourseBatchImportCoursesDecommissioning","description":"Decommissioning info"},"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."}},"required":["course_type","course_name","course_description"]},"LearnCourseBatchImportCoursesContentPartnerFields":{"properties":{"field_xxx":{"type":"string","description":"Multiple additional fields may be added. Simply replace "xxx" with the right field ID (do not use the "human" additional field name"},"enable_session_unenrolment_on_user_deactivated":{"type":"boolean","description":"If true when a user is deactivated he will be unenroled from all the sessions to which he is enroled. Only for classroom / ILT courses"}}},"LearnCourseBatchImportCoursesDecommissioning":{"required":["decommissioned_at","removed_at"],"properties":{"decommissioned_at":{"type":"string","description":"Date of decommissiong"},"removed_at":{"type":"string","description":"Date of course removal"}}},"LearnCourseBatchImportCoursesOptions":{"properties":{"update_course_info":{"type":"boolean","description":"If set to true, if a listed course already exists, his details will be updated, if set to false, an error will be logged for each existing course"},"use_code_to_update":{"type":"boolean","description":"If set to true and course_code is provided as non-empty string, then the course_code would be used for course identification by the API. Otherwise the course_name would be used as fallback"},"s3_key":{"type":"string","description":"Amazon S3 Key of the shared files location"},"s3_secret":{"type":"string","description":"Amazon S3 Secret of the shared files location"},"s3_region":{"type":"string","description":"Amazon S3 Region of the shared files location"},"s3_bucket_name":{"type":"string","description":"Amazon S3 Bucket Name of the shared files location"},"s3_root_folder":{"type":"string","description":"Amazon Root Folder of the shared files location (Do not indicate the s3 root folder as "/". Use "." instead)"}}},"LearnCourseBatchImportCoursesResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnCourseBatchImportCoursesData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseBatchImportCoursesLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseBatchImportCoursesData":{"required":["row_index","success","message"],"properties":{"row_index":{"type":"integer","description":"Import ID for the current record"},"success":{"type":"boolean","description":"Could the record be properly imported?"},"message":{"type":"string","description":"Optional error message"},"course_id":{"type":"integer","description":"Generated course numeric ID in the LMS"},"batch_item_id":{"type":"string","description":"User specified ID for single batch item, passed in input parameters"}}},"LearnCourseBatchImportCoursesLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseBatchImportCoursesSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseBatchImportCoursesGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseBatchImportCoursesFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseBatchImportCoursesLast","description":"Link to the last page"}}},"LearnCourseBatchImportCoursesSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseBatchImportCoursesGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseBatchImportCoursesFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseBatchImportCoursesLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseCreateFieldSchema":{"type":"object","required":["association","name","type","show_field"],"properties":{"association":{"description":"The type of the object associated with the field. Type coursepath usable only when the toggle release/weekly/new-learningplan-management is set to ON. Type certification usable only when the new certification feature is enabled","enum":["course","coursepath","ilt","certification"],"type":"string"},"name":{"$ref":"#/definitions/LearnCourseCreateFieldName","description":"Object containing attributes like language:title, the system default language translation is mandatory. The key is code of the language or all - the value is title (the length of the value must up to 255 characters). For example english, all"},"type":{"description":"The type of the additional field (note: the 'accrediframe' type is not supported for ilt, coursepath)","enum":["date","dropdown","textfield","textarea","accrediframe"],"type":"string"},"dropdown_options":{"type":"array","description":"Array of dropdown options. If type of user field is dropdown, this parameter becomes required","items":{"$ref":"#/definitions/LearnCourseCreateFieldDropdownOptions"}},"settings":{"$ref":"#/definitions/LearnCourseCreateFieldSettings","description":"The settings for the field (at the moment this is used only for the accrediframe settigns)"},"show_field":{"type":"boolean","description":"Whether the field is visible or not in the catalog and course page"},"sequence":{"type":"integer","description":"The sequence order of the field in the list of all additional fields. If not provided will be set as the last."},"filterable":{"type":"boolean","description":"Determine if the field should be present in the catalog filters or not. Default: false"},"multi_choice_filter":{"type":"boolean","description":"Determine if a textfield field should be filterable as exact match or not. This option is related to the fields of "textfield" type only. It's mandatory if the field is of "textfield" type, if it's filterable and visible for users."},"json_config_filter":{"type":"string","description":"JSON configuration of the iFrame filter. This option is related to the fields of "iframe" type only. Required if the field is of "iframe" type and is filterable."},"mandatory":{"type":"boolean","description":"Whether the field is mandatory or not. It cannot be mandatory if the type is accrediframe."},"extra_association":{"description":"The secondary type of the object associated with the field. Usable only when association is course and when the toggle release/weekly/new-learningplan-management is set to ON. This value can be NULL","enum":["coursepath"],"type":"string"}}},"LearnCourseCreateFieldName":{},"LearnCourseCreateFieldDropdownOptions":{"required":["translations"],"properties":{"translations":{"$ref":"#/definitions/LearnCourseCreateFieldTranslations","description":"object of translations, the system default language translation is mandatory. The key is the language or all - the value is title. For example english, all"}}},"LearnCourseCreateFieldTranslations":{},"LearnCourseCreateFieldSettings":{"required":["url","height","columns_catalog","columns_widget","hash_secret","hash_secret_repeat"],"properties":{"url":{"type":"string","description":"The URL for the iframe"},"height":{"type":"integer","description":"The iframe height (in px)"},"columns_catalog":{"type":"integer","description":"Table columns (for the course catalog)"},"columns_widget":{"type":"integer","description":"Table columns (for the course description widget)"},"hash_secret":{"type":"string","description":"The hash secret value for the iframe"},"hash_secret_repeat":{"type":"string","description":"The hash secret value for the iframe (one more time, so we're sure the value is correct"},"oauth_client_id":{"type":"string","description":"The OAuth client ID"},"send_oauth2_token":{"type":"boolean","description":"Whether to send the users OAuth2 token along with the other iframe parameters"}}},"LearnCourseCreateFieldResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseCreateFieldData","description":"ID of the created record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseCreateFieldLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseCreateFieldData":{"required":["field_id"],"properties":{"field_id":{"type":"integer","description":"The internal ID for the newly created course field"}}},"LearnCourseCreateFieldLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseCreateFieldSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseCreateFieldGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseCreateFieldFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseCreateFieldLast","description":"Link to the last page"}}},"LearnCourseCreateFieldSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseCreateFieldGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseCreateFieldFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseCreateFieldLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseDeleteFieldResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseDeleteFieldData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseDeleteFieldLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseDeleteFieldData":{"properties":{"errors":{"$ref":"#/definitions/LearnCourseDeleteFieldErrors","description":"Errors during process"},"deleted":{"type":"string","description":"ID of the successfully deleted item"}}},"LearnCourseDeleteFieldErrors":{"required":["message","errorCode"],"properties":{"message":{"type":"string","description":"Process that generated an error"},"errorCode":{"type":"integer","description":"Error code of the message"}}},"LearnCourseDeleteFieldLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseDeleteFieldSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseDeleteFieldGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseDeleteFieldFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseDeleteFieldLast","description":"Link to the last page"}}},"LearnCourseDeleteFieldSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseDeleteFieldGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseDeleteFieldFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseDeleteFieldLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseIndexFieldResponse":{"required":["data","version","version","version","extra_data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseIndexFieldData","description":"List of all retrieved course additional fields"},"version":{"type":"string","required":"required","description":"Current API version"},"extra_data":{"$ref":"#/definitions/LearnCourseIndexFieldExtraData","description":"More info about retrieved data"},"_links":{"$ref":"#/definitions/LearnCourseIndexFieldLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseIndexFieldData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of course additional fields info objects","items":{"$ref":"#/definitions/LearnCourseIndexFieldItems"}},"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 returned. Returned if get_total_count parameter is 1"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/LearnCourseIndexFieldSort"}}}},"LearnCourseIndexFieldItems":{"required":["id","name","actions","association","extra_association","type","show_field","multi_choice_filter","filterable"],"properties":{"id":{"type":"integer","description":"The ID of the field"},"name":{"$ref":"#/definitions/LearnCourseIndexFieldName","description":"The name of the field"},"dropdown_options":{"$ref":"#/definitions/LearnCourseIndexFieldDropdownOptions","description":"Option ID (key) - translation (value) pairs for the dropdown options (if the field is a dropdown)"},"actions":{"type":"array","description":"A list of possible actions that may be performed to the field","items":{"type":"string"}},"association":{"description":"The type of the object associated with the field","enum":["course","coursepath","ilt","certification"],"type":"string"},"extra_association":{"description":"The type of the additional object associated with the field. It can be null.","enum":["coursepath"],"type":"string"},"type":{"description":"The type of the additional field","enum":["date","dropdown","dropdown_multivalue","textfield","textarea","iframe"],"type":"string"},"show_field":{"type":"boolean","description":"Whether the field is visible or not in the catalog and course page"},"mandatory":{"type":"boolean","description":"Whether the field is mandatory or not"},"settings":{"$ref":"#/definitions/LearnCourseIndexFieldSettings","description":"The settings for the field (at the moment this is used only for the accrediframe settigns)"},"sequence":{"type":"integer","description":"The sequence order of the field in the list of all additional fields"},"multi_choice_filter":{"type":"boolean","description":"Determine if a textfield field should be filterable as exact match or not."},"filterable":{"type":"boolean","description":"Determine if the field should be present in the catalog filters or not."},"textfield_choices":{"type":"array","description":"The text field choices","items":{"type":"string"}},"json_config_filter":{"type":"string","description":"IFRAME configuration, a text area allows to enter a JSON with the definition of the filter fields."}}},"LearnCourseIndexFieldName":{"required":["type","value"],"properties":{"type":{"description":"The type of the translated name. Single value for all the languages, or multiple values for different languages","enum":["single_value","multi_lang"],"type":"string"},"value":{"type":"string","description":"The name of the field for all languages, or the translation for the default language"},"values":{"$ref":"#/definitions/LearnCourseIndexFieldValues","description":"Language (key) - translation (value) pairs if the field has translations for multiple languages"}}},"LearnCourseIndexFieldValues":{},"LearnCourseIndexFieldDropdownOptions":{"required":["type","value","sequence"],"properties":{"type":{"description":"The type of the translated name. Single value for all the languages, or multiple values for different languages","enum":["single_value","multi_lang"],"type":"string"},"value":{"type":"string","description":"The name of the field for all languages, or the translation for the default language"},"values":{"$ref":"#/definitions/LearnCourseIndexFieldValuesL2","description":"Language (key) - translation (value) pairs if the field has translations for multiple languages"},"sequence":{"type":"integer","description":"The sequence order of the option in the list of dropdown options"}}},"LearnCourseIndexFieldValuesL2":{},"LearnCourseIndexFieldSettings":{"required":["url","height","columns_catalog","columns_widget","hash_secret"],"properties":{"url":{"type":"string","description":"The URL for the iframe"},"height":{"type":"integer","description":"The iframe height (in px)"},"columns_catalog":{"type":"integer","description":"Table columns (for the course catalog)"},"columns_widget":{"type":"integer","description":"Table columns (for the course description widget)"},"hash_secret":{"type":"string","description":"The hash secret value for the iframe"},"oauth_client_id":{"type":"integer","description":"The OAuth client ID"},"send_oauth2_token":{"type":"boolean","description":"Whether to send the users OAuth2 token along with the other iframe parameters"}}},"LearnCourseIndexFieldSort":{"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"}}},"LearnCourseIndexFieldExtraData":{"required":["max_allowed"],"properties":{"max_allowed":{"type":"integer","description":"The maximum number of additional fields that are allowed to be created"}}},"LearnCourseIndexFieldLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseIndexFieldSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseIndexFieldGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseIndexFieldFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseIndexFieldLast","description":"Link to the last page"}}},"LearnCourseIndexFieldSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseIndexFieldGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseIndexFieldFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseIndexFieldLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseUpdateFieldSchema":{"type":"object","properties":{"name":{"$ref":"#/definitions/LearnCourseUpdateFieldName","description":"Object containing attributes like language:title, the system default language translation is mandatory. The key is code of the language or all - the value is title (the length of the value must up to 255 characters). For example english, all"},"type":{"description":"The type of the additional field (note: the 'accrediframe' type is not supported for ilt, coursepath)","enum":["date","dropdown","textfield","textarea","accrediframe"],"type":"string"},"association":{"description":"The type of the object associated with the field. Type coursepath usable only when the toggle release/weekly/new-learningplan-management is set to ON. Type certification usable only when the New Certification feature is enabled.","enum":["course","coursepath","ilt","certification"],"type":"string"},"dropdown_options":{"$ref":"#/definitions/LearnCourseUpdateFieldDropdownOptions","description":"Array of dropdown options. If type of user field is dropdown, this parameter becomes required"},"settings":{"$ref":"#/definitions/LearnCourseUpdateFieldSettings","description":"The settings for the field (at the moment this is used only for the accrediframe settigns)"},"show_field":{"type":"boolean","description":"Whether the field is visible or not in the catalog and course page"},"sequence":{"type":"integer","description":"The sequence order of the field in the list of all additional fields"},"mandatory":{"type":"boolean","description":"Whether the field is mandatory or not. It cannot be mandatory if the type is accrediframe."},"filterable":{"type":"boolean","description":"Determine if the field should be present in the catalog filters or not"},"multi_choice_filter":{"type":"boolean","description":"Determine if a textfield field should be filterable as exact match or not. This option is related to the felds of "textfiled" type only. If not passed, the default value will be "false"."},"json_config_filter":{"type":"string","description":"JSON configuration of the iFrame filter. This option is related to the felds of "iframe" type only."},"extra_association":{"description":"The secondary type of the object associated with the field. Usable only when association is course and when the toggle release/weekly/new-learningplan-management is set to ON. This value can be NULL","enum":["coursepath"],"type":"string"}}},"LearnCourseUpdateFieldName":{},"LearnCourseUpdateFieldDropdownOptions":{"properties":{"updated":{"type":"array","description":"Updated options","items":{"$ref":"#/definitions/LearnCourseUpdateFieldUpdated"}},"deleted":{"type":"array","description":"Deleted options","items":{"$ref":"#/definitions/LearnCourseUpdateFieldDeleted"}},"new":{"type":"array","description":"New options","items":{"$ref":"#/definitions/LearnCourseUpdateFieldNew"}}}},"LearnCourseUpdateFieldUpdated":{"properties":{"id_option":{"type":"integer","description":"Id of selected dropdown option."},"sequence":{"type":"integer","description":"The sequence order of the option in the list of all other options for the dropdown"},"translations":{"$ref":"#/definitions/LearnCourseUpdateFieldTranslations","description":"Array of translations, the system default language translation is mandatory. The key is code of the language or all - the value is title. For example en, all"}},"required":["translations"]},"LearnCourseUpdateFieldTranslations":{},"LearnCourseUpdateFieldDeleted":{"properties":{"id_option":{"type":"integer","description":"Id of selected dropdown option."}}},"LearnCourseUpdateFieldNew":{"properties":{"sequence":{"type":"integer","description":"The sequence order of the option in the list of all other options for the dropdown. If not provided it will be set as the last."},"translations":{"$ref":"#/definitions/LearnCourseUpdateFieldTranslationsL2","description":"Array of translations, the system default language translation is mandatory. The key is code of the language or all - the value is title. For example en, all"}},"required":["translations"]},"LearnCourseUpdateFieldTranslationsL2":{},"LearnCourseUpdateFieldSettings":{"required":["url","height","columns_catalog","columns_widget","hash_secret","hash_secret_repeat"],"properties":{"url":{"type":"string","description":"The URL for the iframe"},"height":{"type":"integer","description":"The iframe height (in px)"},"columns_catalog":{"type":"integer","description":"Table columns (for the course catalog)"},"columns_widget":{"type":"integer","description":"Table columns (for the course description widget)"},"hash_secret":{"type":"string","description":"The hash secret value for the iframe"},"hash_secret_repeat":{"type":"string","description":"The hash secret value for the iframe (one more time, so we're sure the value is correct)"},"oauth_client_id":{"type":"string","description":"The OAuth client ID"},"send_oauth2_token":{"type":"boolean","description":"Whether to send the users OAuth2 token along with the other iframe parameters"}}},"LearnCourseUpdateFieldResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseUpdateFieldData","description":"ID of the updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseUpdateFieldLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseUpdateFieldData":{"required":["field_id"],"properties":{"field_id":{"type":"integer","description":"The internal ID for the updated course field"}}},"LearnCourseUpdateFieldLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseUpdateFieldSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseUpdateFieldGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseUpdateFieldFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseUpdateFieldLast","description":"Link to the last page"}}},"LearnCourseUpdateFieldSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseUpdateFieldGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseUpdateFieldFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseUpdateFieldLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseViewFieldResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseViewFieldData","description":"List of all user fields properties"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseViewFieldLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseViewFieldData":{"required":["id","name","association","extra_association","mandatory","type","show_field","filterable","translations"],"properties":{"id":{"type":"integer","description":"The ID of the field"},"name":{"type":"string","description":"The name of the field translated in the currently set language"},"association":{"description":"The type of the object associated with the field","enum":["course","coursepath","ilt","certification"],"type":"string"},"extra_association":{"description":"The type of the additional object associated with the field. It can be null.","enum":["coursepath"],"type":"string"},"mandatory":{"type":"boolean","description":"Whether the field is mandatory or not"},"type":{"description":"The type of the additional field","enum":["date","dropdown","textfield","textarea","accrediframe"],"type":"string"},"show_field":{"type":"boolean","description":"Whether the field is visible or not in the catalog and course page"},"sequence":{"type":"integer","description":"The sequence order of the field in the list of all additional fields"},"filterable":{"type":"boolean","description":"Determine if the field should be present in the catalog filters or not"},"multi_choice_filter":{"type":"boolean","description":"Determine if a textfield field should be filterable as exact match or not. This option is related to the felds of "textfiled" type only. If not passed, the default value will be "false"."},"json_config_filter":{"type":"string","description":"JSON configuration of the iFrame filter. This option is related to the felds of "iframe" type only."},"translations":{"$ref":"#/definitions/LearnCourseViewFieldTranslations","description":"List of all the fields translations in the form of ['language code' => 'translated text']"},"dropdown_options":{"$ref":"#/definitions/LearnCourseViewFieldDropdownOptions","description":"Translations of the dropdown fields options"}}},"LearnCourseViewFieldTranslations":{"required":["__translation__"],"properties":{"__translation__":{"type":"string","description":"The key is language code the value is translation"}}},"LearnCourseViewFieldDropdownOptions":{"required":["option_id","translations"],"properties":{"option_id":{"type":"string","description":"Option ID"},"translations":{"$ref":"#/definitions/LearnCourseViewFieldTranslationsL2","description":"List of all the option translations in the form of ['language code' => 'translated text']. The key is language code the value is translation"},"settings":{"$ref":"#/definitions/LearnCourseViewFieldSettings","description":"The settings for the field (at the moment this is used only for the accrediframe settigns)"}}},"LearnCourseViewFieldTranslationsL2":{},"LearnCourseViewFieldSettings":{"required":["url","height","columns_catalog","columns_widget","hash_secret"],"properties":{"url":{"type":"string","description":"The URL for the iframe"},"height":{"type":"integer","description":"The iframe height (in px)"},"columns_catalog":{"type":"integer","description":"Table columns (for the course catalog)"},"columns_widget":{"type":"integer","description":"Table columns (for the course description widget)"},"hash_secret":{"type":"string","description":"The hash secret value for the iframe"},"oauth_client_id":{"type":"integer","description":"The OAuth client ID"},"send_oauth2_token":{"type":"boolean","description":"Whether to send the users OAuth2 token along with the other iframe parameters"}}},"LearnCourseViewFieldLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseViewFieldSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseViewFieldGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseViewFieldFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseViewFieldLast","description":"Link to the last page"}}},"LearnCourseViewFieldSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseViewFieldGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseViewFieldFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseViewFieldLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseTrackingsSchema":{"type":"object","properties":{"trackings":{"type":"array","description":"Array of (possibly empty) LO trackings for the given course","items":{"$ref":"#/definitions/LearnCourseTrackingsTrackings"}},"sessions":{"type":"array","description":"Array contains the user’s track sessions inside the given course","items":{"$ref":"#/definitions/LearnCourseTrackingsSessions"}}}},"LearnCourseTrackingsTrackings":{"required":["lo_id","timestamp"],"properties":{"lo_id":{"type":"string","description":"ID of course chapter whose trackings must be synchronized"},"timestamp":{"type":"string","description":"The last modification date of this tracking in "yyyy-MM-dd HH:mm:ss" format UTC timezone"},"data":{"$ref":"#/definitions/LearnCourseTrackingsData","description":"A payload containing tracking data specific of some types of training materials. Not present for "file", "html" object types."},"first_attempt":{"type":"string","description":"Date-time of the first attempt of the learner for this learning object in "yyyy-MM-dd HH:mm:ss" format UTC timezone"}}},"LearnCourseTrackingsData":{"properties":{"bookmark":{"type":"integer","description":"The current offset within the content. Only applicable for "video" (i.e. offset in seconds), "slides" (0-based slide number)"},"complete":{"type":"boolean","description":"Whether the video is to be considered completed with this tracking. Only applicable for "video""},"cmi":{"$ref":"#/definitions/LearnCourseTrackingsCmi","description":"The CMI trackings for the given SCORM chapter. Expected format is an JS object of type {"<cmi command>": "<cmi command value>"}. Only applicable for "scorms"."}}},"LearnCourseTrackingsCmi":{},"LearnCourseTrackingsSessions":{"required":["start","end","lo_id"],"properties":{"start":{"type":"string","description":"Start time of the session in "yyyy-MM-dd HH:mm:ss" format UTC timezone"},"end":{"type":"string","description":"End time of the session in "yyyy-MM-dd HH:mm:ss" format UTC timezone"},"lo_id":{"type":"integer","description":"The ID of the learning object being tracked"},"context":{"description":"The context in which the learning object is being played. Default is 'lms'","enum":["lms","golearn","flow","flow_msteams","browser_extension"],"type":"string"}}},"LearnCourseTrackingsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseTrackingsDataL2","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseTrackingsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseTrackingsDataL2":{"required":["course"],"properties":{"course":{"$ref":"#/definitions/LearnCourseTrackingsCourse","description":"Object containing course status info for the requesting user"},"chapters":{"type":"array","description":"Array of chapter records (folders excluded) with the latest status and trackings for the current user (needed to sync the caller with the LMS backend)","items":{"$ref":"#/definitions/LearnCourseTrackingsChapters"}}}},"LearnCourseTrackingsCourse":{"required":["status"],"properties":{"status":{"description":"The user's status inside the specified course","enum":["enrolled","in_progress","completed","subscription_to_confirm","waiting","suspended","overbooking"],"type":"string"},"completion_date":{"type":"string","description":"Date when the user has completed the course"}}},"LearnCourseTrackingsChapters":{"required":["lo_id","status"],"properties":{"lo_id":{"type":"string","description":"ID of course chapter whose tracking have been synced"},"status":{"description":"The current status of the user for this chapter","enum":["completed","failed","not_started","ab-initio","incomplete","in_progress"],"type":"string"},"trackings":{"$ref":"#/definitions/LearnCourseTrackingsTrackingsL2","description":"A payload containing tracking data specific of each type of LO"}}},"LearnCourseTrackingsTrackingsL2":{"properties":{"bookmark":{"type":"integer","description":"The current offset within the content. Only applicable for "video" (i.e. offset in seconds), "slides" (0-based slide number)"},"cmi":{"$ref":"#/definitions/LearnCourseTrackingsCmiL2","description":"The CMI trackings for the given SCORM chapter. Expected format is an JS object of type {"<cmi command>": "<cmi command value>"}. Only applicable for "scorms""}},"required":["cmi"]},"LearnCourseTrackingsCmiL2":{},"LearnCourseTrackingsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseTrackingsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseTrackingsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseTrackingsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseTrackingsLast","description":"Link to the last page"}}},"LearnCourseTrackingsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseTrackingsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseTrackingsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseTrackingsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseDownloadResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseDownloadData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseDownloadLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseDownloadData":{"required":["total_size","job_id","job_starting_date","job_status","success","los"],"properties":{"total_size":{"type":"integer","description":"Total size (in KB) for all downloadable LO (if they are downloadable)"},"job_id":{"type":"string","description":"Hash ID of the job in current download process is in progress. Null if job is completed"},"job_starting_date":{"type":"string","description":"Starting date of the job download process. Null if job is completed"},"job_status":{"description":"Status of the job","enum":["in_progress","completed","failed"],"type":"string"},"success":{"type":"boolean","description":"Status of the job process"},"message":{"type":"string","description":"Message if job fails"},"end_object_mark_id":{"type":"array","description":"Course end object markers IDs. Contains array of strings","items":{"type":"string"}},"los":{"type":"array","description":"Array of course LO","items":{"$ref":"#/definitions/LearnCourseDownloadLos"}}}},"LearnCourseDownloadLos":{"required":["id","type"],"properties":{"id":{"type":"string","description":"Learning Object ID. Could be combination of lo ID and chapter ID in case of SCORM"},"type":{"type":"string","description":"The internal type of the learning object"},"resource_id":{"type":"string","description":"The physical resource ID related to the learning object"},"size":{"type":"integer","description":"Size of the training material in KB in case if could be downloadable"},"path":{"type":"string","description":"Download URL of training material"},"mobile_unsupported":{"type":"boolean","description":"Flag if the LO (SCORM currently only) is not supported by mobile devices"},"metadata":{"$ref":"#/definitions/LearnCourseDownloadMetadata","description":"Additional metadata to the learning object"},"tracking":{"$ref":"#/definitions/LearnCourseDownloadTracking","description":"Tracking information about the learning object for the current user"}}},"LearnCourseDownloadMetadata":{"properties":{"presentation_order":{"type":"array","description":"Array of strings contains the name of the slide files ordered by presentation","items":{"type":"string"}},"seek_mode":{"type":"integer","description":"Video seek mode: 0 - disabled; 1 - enabled; 2 - enabled after completing the video"},"prerequisites":{"type":"array","description":"Contains array of strings of all learning object IDs to unblock the current LO","items":{"type":"string"}},"scorm_version":{"type":"string","description":"Scorm version (in case of SCORM LO)"},"external":{"$ref":"#/definitions/LearnCourseDownloadExternal","description":"External link for TinCan LO and its confabulated to be mobile_use_external_link"},"scorm_items":{"$ref":"#/definitions/LearnCourseDownloadScormItems","description":"Scorm items (in case of SCORM LO)"}}},"LearnCourseDownloadExternal":{"properties":{"deeplink_play":{"type":"string","description":"URL to play LO"},"deeplink_download":{"type":"string","description":"URL to download LO"}}},"LearnCourseDownloadScormItems":{"required":["sco_id","launch_url","requirements","mastery_score"],"properties":{"sco_id":{"type":"string","description":"ID of the SCORM item"},"launch_url":{"type":"string","description":"URL to launch SCORM"},"requirements":{"type":"array","description":"SCORM item requirements","items":{"type":"string"}},"mastery_score":{"type":"integer","description":"SCORM mastery score (in case SCORM is in progress)"}}},"LearnCourseDownloadTracking":{"properties":{"bookmark":{"type":"integer","description":"Current bookmark, in case of video or authoring learning object"},"scorm_items":{"$ref":"#/definitions/LearnCourseDownloadScormItemsL2","description":"Scorm items tracking information"}}},"LearnCourseDownloadScormItemsL2":{"required":["sco_id","cmi"],"properties":{"sco_id":{"type":"string","description":"ID of the SCORM item"},"cmi":{"$ref":"#/definitions/LearnCourseDownloadCmi","description":"SCORM CMI instructions"}}},"LearnCourseDownloadCmi":{},"LearnCourseDownloadLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseDownloadSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseDownloadGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseDownloadFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseDownloadLast","description":"Link to the last page"}}},"LearnCourseDownloadSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseDownloadGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseDownloadFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseDownloadLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseBatchResetTrackingSchema":{"type":"object","properties":{"options":{"$ref":"#/definitions/LearnCourseBatchResetTrackingOptions","description":"Object containing the request options"}}},"LearnCourseBatchResetTrackingOptions":{"properties":{"owner_type":{"description":"For which user entity to reset the tracking data. This parameter is applicable and required for Super Admin only. Regular User can reset only his own tracking data.","enum":["user","group","branch"],"type":"string"},"owner_id":{"type":"integer","description":"The ID of the owner_type entity. This parameter is applicable and required for Super Admin only. Regular User can reset only his own tracking data."},"reset_lrs":{"type":"boolean","description":"Whether to remove or not the data for the lrs in case of tincan objects. Default is "false""},"include_elearning_courses_without_trackings":{"type":"boolean","description":"Whether to reset e-learning courses without trackings or not. Default is "false""}}},"LearnCourseBatchResetTrackingResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseBatchResetTrackingData","description":"Response array"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCourseBatchResetTrackingLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCourseBatchResetTrackingData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Was the tracking data for the (LO - Owner) pair, properly reset"},"messages":{"type":"array","description":"Messages, if the operation had errors or warnings","items":{"type":"string"}}}},"LearnCourseBatchResetTrackingLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCourseBatchResetTrackingSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCourseBatchResetTrackingGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCourseBatchResetTrackingFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCourseBatchResetTrackingLast","description":"Link to the last page"}}},"LearnCourseBatchResetTrackingSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCourseBatchResetTrackingGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCourseBatchResetTrackingFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCourseBatchResetTrackingLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnCourseCreateCourseDismissionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseCreateCourseDismissionData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseCreateCourseDismissionData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"The status of the operation"}}},"LearnCourseUndoCourseDismissionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseUndoCourseDismissionData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseUndoCourseDismissionData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"The status of the operation"}}},"LearnCourseReportCourseResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseReportCourseData","description":""},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseReportCourseData":{"required":["success","already_marked"],"properties":{"success":{"type":"boolean","description":"The result of the operation"},"already_marked":{"type":"boolean","description":"Indicates if the given course is already marked as outdated"}}},"LearnCourseCreateIltsessionSchema":{"type":"object","required":["name","max_enroll","dates"],"properties":{"name":{"type":"string","description":"ILT session name"},"session_code":{"type":"string","description":"ILT session code"},"max_enroll":{"type":"integer","description":"Maximum number of allowed enrollments"},"min_enroll":{"type":"integer","description":"Minimum number of allowed enrollments"},"last_subscription_date":{"type":"string","format":"date","description":"Last day to be able to subscribe to the session. Self enrollment will not be available past the inserted date"},"other_info":{"type":"string","description":"Additional information about the session"},"evaluation_type":{"type":"integer","description":"0 = online test, 1 = manual evaluation"},"additional_fields":{"type":"array","description":"Additional fields value. For "date" type the date format should be "yyyy-mm-dd"","items":{"$ref":"#/definitions/LearnCourseCreateIltsessionAdditionalFields"}},"score_base":{"type":"integer","description":"This value is valid only if the evaluation_type is 1"},"dates":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCourseCreateIltsessionDates"}}}},"LearnCourseCreateIltsessionAdditionalFields":{"properties":{"id":{"type":"integer","description":"Internal ID of the field"},"value":{"type":"string","description":"Value of the field"}}},"LearnCourseCreateIltsessionDates":{"required":["day","name","time_begin","time_end","break_begin","break_end","timezone","id_location"],"properties":{"day":{"type":"string","format":"date","description":"Date of the session date. The value is in UTC timezone, if your timezone is different you will need to convert that date in UTC"},"name":{"type":"string","description":"Date name"},"time_begin":{"type":"string","description":"Time of day when the date starts."},"time_end":{"type":"string","description":"Time of day when the date ends."},"break_begin":{"type":"string","description":"Time of day when the break starts."},"break_end":{"type":"string","description":"Time of day when the break ends."},"timezone":{"type":"string","description":"Timezone related to start and end time of the date and break"},"id_location":{"type":"integer","description":"internal ID of the date location"},"id_classroom":{"type":"integer","description":"internal ID of the date classroom"}}},"LearnCourseCreateIltsessionResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseCreateIltsessionData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Always empty","items":{"$ref":"#/definitions/LearnCourseCreateIltsessionLinks"}}}},"LearnCourseCreateIltsessionData":{"required":["id_session"],"properties":{"id_session":{"type":"integer","description":"Internal Docebo ID for the new session."}}},"LearnCourseCreateIltsessionLinks":{},"LearnCourseUpdateIltsessionSchema":{"type":"object","required":["name","max_enroll","dates"],"properties":{"name":{"type":"string","description":"ILT session name"},"session_code":{"type":"string","description":"ILT session code"},"max_enroll":{"type":"integer","description":"Maximum number of allowed enrollments"},"min_enroll":{"type":"integer","description":"Minimum number of allowed enrollments"},"last_subscription_date":{"type":"string","format":"date","description":"Last day to be able to subscribe to the session. Self enrollment will not be available past the inserted date"},"other_info":{"type":"string","description":"Additional information about the session"},"evaluation_type":{"type":"integer","description":"0 = online test, 1 = manual evaluation"},"score_base":{"type":"integer","description":"This value is valid only if the evaluation_type is 1"},"dates":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCourseUpdateIltsessionDates"}},"additional_fields":{"type":"array","description":"Additional fields value. For "date" type the date format should be "yyyy-mm-dd" (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/LearnCourseUpdateIltsessionAdditionalFields"}}}},"LearnCourseUpdateIltsessionDates":{"required":["day","name","time_begin","time_end","break_begin","break_end","timezone","id_location"],"properties":{"day":{"type":"string","format":"date","description":"Date of the session date. The value is in UTC timezone, if your timezone is different you will need to convert that date in UTC"},"name":{"type":"string","description":"Date name"},"time_begin":{"type":"string","description":"Time of day when the date starts."},"time_end":{"type":"string","description":"Time of day when the date ends."},"break_begin":{"type":"string","description":"Time of day when the break starts."},"break_end":{"type":"string","description":"Time of day when the break ends."},"timezone":{"type":"string","description":"Timezone related to start and end time of the date and break"},"id_location":{"type":"integer","description":"internal ID of the date location"},"id_classroom":{"type":"integer","description":"internal ID of the date classroom"}}},"LearnCourseUpdateIltsessionAdditionalFields":{"properties":{"id":{"type":"integer","description":"Internal ID of the field"},"value":{"type":"string","description":"Value of the field"}}},"LearnCourseUpdateIltsessionResponse":{"required":["id_session","version"],"properties":{"id_session":{"type":"integer","description":"Internal Docebo ID for the updated session."},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseDeleteIltsessionResponse":{"required":["data","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseDeleteIltsessionData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Always empty","items":{"$ref":"#/definitions/LearnCourseDeleteIltsessionLinks"}}}},"LearnCourseDeleteIltsessionData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"The operation success status"}}},"LearnCourseDeleteIltsessionLinks":{},"LearnCourseListIltsessionResponse":{"required":["sessions","version"],"properties":{"sessions":{"type":"array","description":"The array of reports","items":{"$ref":"#/definitions/LearnCourseListIltsessionSessions"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseListIltsessionSessions":{"required":["id_session","id_course","name","max_enroll","date_begin","date_end","dates"],"properties":{"id_session":{"type":"integer","description":"The ID of the date"},"id_course":{"type":"integer","description":"The ID of the course"},"name":{"type":"string","description":""},"max_enroll":{"type":"integer","description":"Maximum number of allowed enrollments"},"min_enroll":{"type":"integer","description":"Minimum number of allowed enrollments"},"date_begin":{"type":"string","format":"date","description":"Beginning date of the ILT session (UTC timezone)"},"date_end":{"type":"string","format":"date","description":"End date of the ILT session (UTC timezone)"},"last_subscription_date":{"type":"string","format":"date","description":"Last day to be able to subscribe to the session. Self enrollment will not be available past the inserted date"},"other_info":{"type":"string","description":"Additional information about the session"},"evaluation_type":{"type":"integer","description":"0 = online test, 1 = manual evaluation"},"score_base":{"type":"integer","description":"This value is valid only if the evaluation_type is 1"},"dates":{"type":"array","description":"","items":{"$ref":"#/definitions/LearnCourseListIltsessionDates"}}}},"LearnCourseListIltsessionDates":{"required":["day","name","time_begin","time_end","break_begin","break_end","timezone","location_name","location_address","id_location","id_classroom"],"properties":{"day":{"type":"string","format":"date","description":"Note: this will be expressed in the timezone"},"name":{"type":"string","description":"Date name"},"time_begin":{"type":"string","description":"Time of day when the date starts."},"time_end":{"type":"string","description":"Time of day when the date ends."},"break_begin":{"type":"string","description":"Time of day when the break starts."},"break_end":{"type":"string","description":"Time of day when the break ends."},"timezone":{"type":"string","description":"Timezone related to start and end time of the date and break"},"location_name":{"type":"string","description":"Date location name"},"location_address":{"type":"string","description":"Date location address"},"id_location":{"type":"integer","description":"internal ID of the date location"},"id_classroom":{"type":"integer","description":"internal ID of the date classroom"}}},"LearnCourseVisibilityCheckSchema":{"type":"object","required":["course_id","context"],"properties":{"course_id":{"type":"integer","description":"The course ID to check"},"context":{"description":"The context where check the course","enum":["internal-catalog","external-catalog","my-courses-and-lps","global-search","specific-internal-catalog","specific-external-catalog","channels","specific-channel"],"type":"string"},"user_id":{"type":"integer","description":"The user ID. It's required for internal-catalog, my-courses-and-lps, global-search, specific-internal-catalog contexts"},"catalog_id":{"type":"integer","description":"The specific catalog ID. It's required for specific-internal-catalog context"},"channel_id":{"type":"integer","description":"The specific channel ID. It's required for specific-channel context"}}},"LearnCourseVisibilityCheckResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnCourseVisibilityCheckData","description":"The response data"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnCourseVisibilityCheckData":{"required":["visibility","lock"],"properties":{"visibility":{"$ref":"#/definitions/LearnCourseVisibilityCheckVisibility","description":"The visibility status"},"lock":{"$ref":"#/definitions/LearnCourseVisibilityCheckLock","description":"The lock status"}}},"LearnCourseVisibilityCheckVisibility":{"required":["is_visible","reason","suggestion"],"properties":{"is_visible":{"type":"boolean","description":"Indicates if the course is visible in the selected context"},"reason":{"type":"string","description":"The reason why the course is not visible"},"suggestion":{"type":"string","description":"A suggestion to show the course"}}},"LearnCourseVisibilityCheckLock":{"required":["is_lock","reason","suggestion"],"properties":{"is_lock":{"type":"boolean","description":"Indicates if the course is locked"},"reason":{"type":"string","description":"The reason why the course is locked"},"suggestion":{"type":"string","description":"A suggestion to unlock the course"}}},"LearnCoursedescGetCourseDescriptionResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Information about the course.","items":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnCoursedescGetCourseDescriptionData":{"required":["course_description"],"properties":{"course_description":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionCourseDescription","description":"Course Description object"}}},"LearnCoursedescGetCourseDescriptionCourseDescription":{"required":["Title","Description","Additional_fields"],"properties":{"Title":{"type":"string","description":"the name of the course."},"Description":{"type":"string","description":"the description of the course."},"Additional_fields":{"type":"array","description":"array of title and value for each additional field in the course.","items":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionAdditionalFields"}}}},"LearnCoursedescGetCourseDescriptionAdditionalFields":{"required":["id","title","type","value"],"properties":{"id":{"type":"string","description":"Additional filed ID"},"title":{"type":"string","description":"Additional field name"},"type":{"type":"string","description":"Additional field type"},"value":{"type":"string","description":"Additional field value"},"mandatory":{"type":"boolean","description":"Whether the field is mandatory or not"}}},"LearnCoursedescGetCourseDescriptionLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnCoursedescGetCourseDescriptionLast","description":"Link to the last page"}}},"LearnCoursedescGetCourseDescriptionSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnCoursedescGetCourseDescriptionGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnCoursedescGetCourseDescriptionFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnCoursedescGetCourseDescriptionLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentCreateSchema":{"type":"object","required":["course_ids","user_ids","level","enrollment_fields"],"properties":{"course_ids":{"type":"array","description":"The id of the course/s","items":{"type":"integer"}},"user_ids":{"type":"array","description":"The id of enrolled user/s. If is provided subscription_record, providing of user_ids, group_ids or branch_ids is mandatory","items":{"type":"integer"}},"group_ids":{"type":"array","description":"The ID of group/s. If is provided subscription_record, providing of user_ids, group_ids or branch_ids is mandatory","items":{"type":"integer"}},"level":{"description":"Level of enrolled user, 3 => student, 4 => tutor, 6 => instructor","enum":["3","4","6"],"type":"integer"},"date_begin_validity":{"type":"string","format":"date","description":"Starting date of the enrollment. The date format should be "yyyy-mm-dd HH:mm:ss" or "yyyy-mm-dd"."},"date_expire_validity":{"type":"string","format":"date","description":"Expiration date of the enrollment. The date format should be "yyyy-mm-dd HH:mm:ss" or "yyyy-mm-dd"."},"session_id":{"type":"integer","description":"session of ILT to be enrolled into. If the field is filled in then the user will be enrolled in the session also for ILT."},"subscription_record":{"type":"integer","description":"ID of a subscription record"},"notification_ids":{"type":"array","description":"ID of notifications to be triggered","items":{"type":"integer"}},"notification_uuids":{"type":"array","description":"ID of notifications to be triggered","items":{"type":"string"}},"enrollment_fields":{"$ref":"#/definitions/LearnEnrollmentCreateEnrollmentFields","description":"Array of additional fields for the enrollment. The key is the enrollment field ID, the value is the value of the enrollment field"},"consider_ef_as_optional":{"type":"boolean","description":"The Default value is false, if true and the enrollment_fields field is empty or missing, no check about the mandatory Additional Enrollment Fields will be performed."},"branches":{"type":"array","description":"Array of objects containing information for the branches","items":{"$ref":"#/definitions/LearnEnrollmentCreateBranches"}},"atomic_enrollment":{"type":"boolean","description":"System flag to force the endpoint to commit changes to course enrollments if all of them are successfully performed. Can be used only by a SA and only as true, with only one user_id inside user_ids per call and without group_ids or branches or session_id. When this parameter is used, the endpoint returns a 200 response also if the user is already enrolled in one or more courses in input, that will still be returned in as “errors” in the response"},"assignment_type":{"description":"Assignment Type enrollment attribute. Can be passed only when the attribute is configured in the platform advanced settings. The possible values are "mandatory", "required", "recommended", "optional" but to be accepted they must be enabled in the settings. This parameter is optional.","enum":["mandatory","required","recommended","optional"],"type":"string"},"enrolled_at":{"type":"string","format":"date","description":"Date of the enrollment into the course. It's defaulted to the enrollment creation in the LMS. It can be customized with a value in the past only by a Superadmin."}}},"LearnEnrollmentCreateEnrollmentFields":{},"LearnEnrollmentCreateBranches":{"required":["branch_id"],"properties":{"branch_id":{"type":"integer","description":"Branch ID"},"selected_status":{"type":"integer","description":"Selection status of the given branch. Options - 1(only branch), 2(with children)"}}},"LearnEnrollmentCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentCreateData","description":"Results of the enroll process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentCreateLinks","description":"Links to related resources. It's an array when empty. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentCreateData":{"required":["errors"],"properties":{"errors":{"type":"array","description":"Errors during process, e.g. course does not exist...","items":{"$ref":"#/definitions/LearnEnrollmentCreateErrors"}}}},"LearnEnrollmentCreateErrors":{"required":["enrolled"],"properties":{"enrolled":{"type":"array","description":"List with successfully enrolled users. It's empty when an error occurs.","items":{"$ref":"#/definitions/LearnEnrollmentCreateEnrolled"}}}},"LearnEnrollmentCreateEnrolled":{"properties":{"id_user":{"type":"integer","description":"User ID."},"id_course":{"type":"integer","description":"Course ID."},"waiting":{"type":"boolean","description":"Whether it's a pending enrollment."}}},"LearnEnrollmentCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentCreateLast","description":"Link to the last page"}}},"LearnEnrollmentCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentDeleteData":{"required":["deleted_enrollment"],"properties":{"deleted_enrollment":{"type":"integer","description":"ID of the successfully deleted enrollment"}}},"LearnEnrollmentDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentDeleteLast","description":"Link to the last page"}}},"LearnEnrollmentDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentViewData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentViewData":{"required":["records"],"properties":{"records":{"$ref":"#/definitions/LearnEnrollmentViewRecords","description":""}}},"LearnEnrollmentViewRecords":{"required":["id","name","description","type","status","lang_code","course_code","enroll_begin_date","course_complete_date","total_time","score","score_given","enrollment_fields"],"properties":{"id":{"type":"string","description":"Course ID"},"name":{"type":"string","description":"Course name"},"description":{"type":"string","description":"Course description"},"type":{"description":"Type of course","enum":["elearning","classroom"],"type":"string"},"status":{"type":"string","description":"Enrollment Status: -2: Waiting Users, -1: Subscriptions to Confirm, 0: Subscribed, 1: In Progress, 2: Completed, 3: Suspended, 4: Overbooking"},"lang_code":{"type":"string","description":"Language code"},"course_code":{"type":"string","description":"Code of course"},"enroll_begin_date":{"type":"string","format":"date","description":"Date of user enrollment"},"course_complete_date":{"type":"string","format":"date","description":"Date when user complete this course"},"total_time":{"type":"integer","description":"Total time of user in seconds"},"score":{"type":"string","description":"Score of user"},"score_given":{"type":"integer","description":"Score of user"},"enrollment_fields":{"$ref":"#/definitions/LearnEnrollmentViewEnrollmentFields","description":"Object of additional enrollment fields"},"subscription":{"$ref":"#/definitions/LearnEnrollmentViewSubscription","description":"Array show in response only if the subscription app is active"}}},"LearnEnrollmentViewEnrollmentFields":{},"LearnEnrollmentViewSubscription":{"required":["subscribed"],"properties":{"subscribed":{"type":"boolean","description":"If exist record in sub_record_enrollments"},"is_active":{"type":"boolean","description":"Subscription record must be active AND the expiration date in the future for 'true' value."}}},"LearnEnrollmentViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentViewLast","description":"Link to the last page"}}},"LearnEnrollmentViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentMultipleDeleteSchema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","description":"The id of enrolled user","items":{"type":"integer"}},"course_ids":{"type":"array","description":"The ids of the courses. It can be a single value or an array of values. The parameter is required if learningplan_ids is not passed or empty.","items":{"type":"integer"}},"learningplan_ids":{"type":"array","description":"The ids of learning plans. It can be a single value or an array of values. The parameter is required if course_ids is not passed or empty.","items":{"type":"integer"}},"reset_tracks":{"type":"boolean","description":"Set to true to reset all the learner's tracked data. Default is false."},"cascade_unenroll_from_courses_in_selected_learning_plan":{"type":"boolean","description":"If set to true, un-enroll the user from the courses of the learning plan (and possibly reset their trackings). Default is false"},"delete_issued_certificates":{"type":"boolean","description":"Delete previously issued certificates for users enrolled in passed courses."}}},"LearnEnrollmentMultipleDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentMultipleDeleteData","description":"Results of the un-enroll process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentMultipleDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentMultipleDeleteData":{"required":["errors","un_enrolled"],"properties":{"errors":{"type":"array","description":"Errors during process, e.g. course does not exist...","items":{"type":"string"}},"un_enrolled":{"type":"array","description":"List with successfully un-enrolled users","items":{"type":"integer"}}}},"LearnEnrollmentMultipleDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentMultipleDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentMultipleDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentMultipleDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentMultipleDeleteLast","description":"Link to the last page"}}},"LearnEnrollmentMultipleDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentMultipleDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentMultipleDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentMultipleDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentUpdateSingleSchema":{"type":"object","properties":{"edition_id":{"type":"integer","description":"Edition ID. It can be modified only by PU and SA users."},"level":{"type":"integer","description":"Level of enrolled user. Possible values: [3] => learner, [4] => tutor, [6] => instructor. It can be modified only by PU and SA users."},"date_inscr":{"type":"string","format":"date","description":"Date of insert (e.g "2015-06-30 11:27:34"). It can be modified only by PU and SA users."},"date_first_access":{"type":"string","format":"date","description":"Date of first access (e.g "2015-06-30 11:27:34" or "2015-06-30"). It can be modified only by PU and SA users."},"date_last_access":{"type":"string","format":"date","description":"Date of last access (e.g "2015-06-30 11:27:34" or "2015-06-30"). It can be modified only by PU and SA users."},"date_complete":{"type":"string","format":"date","description":"Date of last complete (e.g "2015-06-30 11:27:34" or "2015-06-30"). It can be modified only by PU and SA users."},"status":{"type":"integer","description":"Enrollment Status: -2: Waiting Users, -1: Subscriptions to Confirm, 0: Subscribed, 1: In Progress, 2: Completed, 3: Suspended, 4: Overbooking. It can be modified only by PU and SA users."},"subscribed_by":{"type":"integer","description":"Subscribed by user ID. It can be modified only by PU and SA users."},"rule_log":{"type":"integer","description":"Rule log. It can be modified only by PU and SA users."},"score_given":{"type":"integer","description":"Score given. It can be modified only by PU and SA users."},"imported_from_connection":{"type":"string","description":"Imported from connection. It can be modified only by PU and SA users."},"absent":{"type":"integer","description":"Absent. It can be modified only by PU and SA users."},"cancelled_by":{"type":"integer","description":"Cancelled by user ID. It can be modified only by PU and SA users."},"new_forum_post":{"type":"integer","description":"New forum post. It can be modified only by PU and SA users."},"date_begin_validity":{"type":"string","format":"date","description":"Date begin of the enrollment (e.g "2015-06-30 11:27:34" or "2015-06-30"). It can be modified only by PU and SA users."},"date_expire_validity":{"type":"string","format":"date","description":"Expiry date of the enrollment (e.g "2015-06-30 11:27:34" or "2015-06-30"). It can be modified only by PU and SA users."},"session_id":{"type":"integer","description":"session of ILT to be enrolled into. If the field is filled in then the user will be enrolled in the session also for ILT. If the course ID belongs to an e-learning, this field will be ignored."},"requesting_unsubscribe":{"type":"integer","description":"Requesting unsubscribe. It can be modified only by PU and SA users."},"requesting_unsubscribe_date":{"type":"string","format":"date","description":"Requesting unsubscribe date. It can be modified only by PU and SA users."},"initial_score_given":{"type":"integer","description":"Initial score given. It can be modified only by PU and SA users."},"deeplinked_by":{"type":"integer","description":"Deeplinked by user ID. It can be modified only by PU and SA users."},"enrollment_fields":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleEnrollmentFields","description":"Enrollment fields. The key is the enrollment field ID, the value is the value of the enrollment field"},"assignment_type":{"description":"Assignment Type enrollment attribute. Can be passed only when the attribute is configured in the platform advanced settings. The possible values are "mandatory", "required", "recommended", "optional" but to be accepted they must be enabled in the settings. If the value is NULL, reset the value.","enum":["mandatory","required","recommended","optional"],"type":"string"}}},"LearnEnrollmentUpdateSingleEnrollmentFields":{},"LearnEnrollmentUpdateSingleResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleData","description":"ID of updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentUpdateSingleData":{"required":["updated","not_updated"],"properties":{"updated":{"type":"array","description":"Array of updated enrollments","items":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleUpdated"}},"not_updated":{"type":"array","description":"Array of NOT updated courses and users","items":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleNotUpdated"}}}},"LearnEnrollmentUpdateSingleUpdated":{"required":["course_id","user_id"],"properties":{"course_id":{"type":"integer","description":"Course ID"},"user_id":{"type":"integer","description":"User ID"}}},"LearnEnrollmentUpdateSingleNotUpdated":{"properties":{"invalid_enrollments":{"type":"array","description":"Array of provided invalid enrollments","items":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleInvalidEnrollments"}},"validation_errors":{"type":"array","description":"Array of not updated enrollments because of model validation errors","items":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleValidationErrors"}}}},"LearnEnrollmentUpdateSingleInvalidEnrollments":{"properties":{"course_id":{"type":"integer","description":"Course ID"},"user_id":{"type":"integer","description":"User ID"}}},"LearnEnrollmentUpdateSingleValidationErrors":{"properties":{"ids":{"type":"array","description":"Array of IDs of not updated enrollments","items":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleIds"}},"messages":{"type":"array","description":"Array of error messages","items":{"type":"string"}}}},"LearnEnrollmentUpdateSingleIds":{"required":["course_id","user_id"],"properties":{"course_id":{"type":"integer","description":"Course ID"},"user_id":{"type":"integer","description":"User ID"}}},"LearnEnrollmentUpdateSingleLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentUpdateSingleLast","description":"Link to the last page"}}},"LearnEnrollmentUpdateSingleSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentUpdateSingleGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentUpdateSingleFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentUpdateSingleLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentUpdateMultipleSchema":{"type":"object","required":["user_ids","course_ids"],"properties":{"user_ids":{"type":"array","description":"User ID(s)","items":{"type":"integer"}},"course_ids":{"type":"array","description":"Course ID(s)","items":{"type":"integer"}},"edition_id":{"type":"integer","description":"Edition ID"},"level":{"type":"integer","description":"Level of enrolled user. Possible values: [3] => learner, [4] => tutor, [6] => instructor"},"date_inscr":{"type":"string","format":"date","description":"Date of insert (e.g "2015-06-30 11:27:34")"},"date_first_access":{"type":"string","format":"date","description":"Date of first access (e.g "2015-06-30 11:27:34")"},"date_last_access":{"type":"string","format":"date","description":"Date of last access (e.g "2015-06-30 11:27:34")"},"date_complete":{"type":"string","format":"date","description":"Date of last complete (e.g "2015-06-30 11:27:34")"},"status":{"type":"integer","description":"Enrollment Status: -2: Waiting Users, -1: Subscriptions to Confirm, 0: Subscribed, 1: In Progress, 2: Completed, 3: Suspended, 4: Overbooking"},"subscribed_by":{"type":"integer","description":"Subscribed by user ID"},"rule_log":{"type":"integer","description":"Rule log"},"score_given":{"type":"integer","description":"Score given"},"imported_from_connection":{"type":"string","description":"Imported from connection"},"absent":{"type":"integer","description":"Absent"},"cancelled_by":{"type":"integer","description":"Cancelled by user ID"},"new_forum_post":{"type":"integer","description":"New forum post"},"date_begin_validity":{"type":"string","format":"date","description":"Date begin of the enrollment (e.g "2015-06-30 11:27:34")"},"date_expire_validity":{"type":"string","format":"date","description":"Expiry date of the enrollment (e.g "2015-06-30 11:27:34")"},"session_id":{"type":"integer","description":"session of ILT to be enrolled into. If the field is filled in then the user will be enrolled in the session also for ILT."},"requesting_unsubscribe":{"type":"integer","description":"Requesting unsubscribe"},"requesting_unsubscribe_date":{"type":"string","format":"date","description":"Requesting unsubscribe date"},"initial_score_given":{"type":"integer","description":"Initial score given"},"deeplinked_by":{"type":"integer","description":"Deeplinked by user ID"},"enrollment_fields":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleEnrollmentFields","description":"Enrollment fields"},"assignment_type":{"description":"// Assignment Type enrollment attribute. Can be passed only when the attribute is configured in the platform advanced settings. The possible values are "mandatory", "required", "recommended", "optional" but to be accepted they must be enabled in the settings. If the value is NULL, reset the value.","enum":["mandatory","required","recommended","optional"],"type":"string"}}},"LearnEnrollmentUpdateMultipleEnrollmentFields":{"required":["enrollment_field_id"],"properties":{"enrollment_field_id":{"type":"string","description":"The key is the enrollment field ID, the value is the value of the enrollment field"}}},"LearnEnrollmentUpdateMultipleResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleData","description":"ID of updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentUpdateMultipleData":{"required":["updated","not_updated"],"properties":{"updated":{"type":"array","description":"Array of updated enrollments","items":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleUpdated"}},"not_updated":{"type":"array","description":"Array of NOT updated courses and users","items":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleNotUpdated"}},"invalid_enrollments":{"type":"array","description":"Array of provided invalid enrollments","items":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleInvalidEnrollments"}},"validation_errors":{"type":"array","description":"Array of not updated enrollments because of model validation errors","items":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleValidationErrors"}}}},"LearnEnrollmentUpdateMultipleUpdated":{"required":["course_id","user_id"],"properties":{"course_id":{"type":"integer","description":"Course ID"},"user_id":{"type":"integer","description":"User ID"},"session_id":{"type":"integer","description":"Session ID"}}},"LearnEnrollmentUpdateMultipleNotUpdated":{"required":["course_id","user_id"],"properties":{"course_id":{"type":"integer","description":"Course ID"},"user_id":{"type":"integer","description":"User ID"}}},"LearnEnrollmentUpdateMultipleInvalidEnrollments":{"properties":{"course_id":{"type":"integer","description":"Course ID"},"user_id":{"type":"integer","description":"User ID"}}},"LearnEnrollmentUpdateMultipleValidationErrors":{"properties":{"ids":{"type":"array","description":"Array of IDs of not updated enrollments","items":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleIds"}}}},"LearnEnrollmentUpdateMultipleIds":{"properties":{"messages":{"type":"array","description":"Array of error messages","items":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleMessages"}}}},"LearnEnrollmentUpdateMultipleMessages":{},"LearnEnrollmentUpdateMultipleLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentUpdateMultipleLast","description":"Link to the last page"}}},"LearnEnrollmentUpdateMultipleSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentUpdateMultipleGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentUpdateMultipleFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentUpdateMultipleLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentCreateSingleSchema":{"type":"object","properties":{"level":{"type":"integer","description":"Level of enrolled user: 3 - Student; 4 - Tutor; 6 - Instructor"},"date_begin_validity":{"type":"string","format":"date","description":"Starting date of the enrollment"},"date_expire_validity":{"type":"string","format":"date","description":"Expiration date of the enrollment"},"session_id":{"type":"integer","description":"session of ILT to be enrolled into. If the field is filled in then the user will be enrolled in the session also for ILT."},"subscription_record":{"type":"integer","description":"ID of a subscription record"},"enrollment_fields":{"$ref":"#/definitions/LearnEnrollmentCreateSingleEnrollmentFields","description":"Object of enrollment additional fields whose keys are the field ID (eg { "5": "field_value", "11": "field_value", ... }). This object is considered only in case of a new course enrollment, otherwise it's ignored."}},"required":["enrollment_fields"]},"LearnEnrollmentCreateSingleEnrollmentFields":{},"LearnEnrollmentCreateSingleResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentCreateSingleData","description":"Results of the enroll process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentCreateSingleLinks","description":"Links to related resources. It's an empty array when pagination is not used. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentCreateSingleData":{"required":["errors","enrolled"],"properties":{"errors":{"type":"array","description":"Errors during process, e.g. course does not exist, etc. It may be an object in case of particular errors.","items":{"type":"string"}},"enrolled":{"type":"array","description":"List with successfully enrolled users. May be empty if all the operations failed.","items":{"type":"integer"}}}},"LearnEnrollmentCreateSingleLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentCreateSingleSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentCreateSingleGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentCreateSingleFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentCreateSingleLast","description":"Link to the last page"}}},"LearnEnrollmentCreateSingleSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentCreateSingleGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentCreateSingleFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentCreateSingleLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentBatchImportSchema":{"type":"object","required":["items","options","trigger_gamification"],"properties":{"items":{"type":"array","description":"Array containing objects of values to be imported. Maximum size = 300 items.","items":{"$ref":"#/definitions/LearnEnrollmentBatchImportItems"}},"options":{"$ref":"#/definitions/LearnEnrollmentBatchImportOptions","description":"Object containing additional options."},"trigger_gamification":{"type":"boolean","description":"Trigger student completed course; Default: false"}}},"LearnEnrollmentBatchImportItems":{"required":["course_code","course_id","username","user_id","enrollment_date"],"properties":{"course_code":{"type":"string","description":"The code of the course"},"course_id":{"type":"integer","description":"The numeric ID of the course in the LMS. It can be omitted if a valid 'course_code' parameter is provided"},"session_code":{"type":"string","description":"The code of the session"},"session_id":{"type":"integer","description":"The id of the session"},"username":{"type":"string","description":"The LMS username of the user. It can be specified instead of 'user_id' parameter"},"user_id":{"type":"string","description":"The ID of the user. It can be omitted if a valid 'username' parameter is provided"},"level":{"description":"Enrollment level, "student" and "learner" are identical. For new ILT courses, The instructors can not be enrolled.","enum":["student","tutor","instructor","coach","learner"],"type":"string"},"status":{"description":"This field is required if NOT set inside the 'options' object.","enum":["subscribed","in_progress","completed","waiting","to_confirm","suspended"],"type":"string"},"enrollment_date":{"type":"string","description":"Date of insert (YYYY-MM-DD HH:MM:SS e.g "2015-06-30 12:00:00")"},"completion_date":{"type":"string","description":"Date of last complete (YYYY-MM-DD HH:MM:SS e.g "2015-06-30 12:00:00")"},"active_from":{"type":"string","description":"Start date of the enrollment in UTC (YYYY-MM-DD HH:MM:SS e.g "2019-06-30 12:00:00")."},"active_until":{"type":"string","description":"Expiry date of the enrollment in UTC (YYYY-MM-DD HH:MM:SSe.g "2015-06-30 12:00:00")."},"score":{"type":"string","description":"Score given"},"subscription_code":{"type":"string","description":"Code of subscription"},"evaluation_text":{"type":"string","description":"Evaluation text (only for ILT)"},"evaluation_date":{"type":"string","description":"Evaluation date (only for ILT) (e.g "2015-06-30")"},"evaluation_score":{"type":"string","description":"Evaluation score (only for ILT)"},"passed":{"type":"boolean","description":"Indicates if the user passed or not (true or false)"},"present":{"type":"boolean","description":"Indicates if the user was present at the session. If set to true, the user attendance is set to "Present" for all the events of the session. It is ignored otherwise."},"timezone":{"type":"string","description":"Time zone: UTC, Europe/Sofia, etc. It applies only to enrollment_date and completion_date fields. Default: "UTC""},"field_xxx":{"type":"string","description":"Multiple additional fields may be added. Simply replace "xxx" with the right field ID (do not use the "human" additional field name"},"batch_item_id":{"type":"string","description":"Client-specified ID for the current batch item. IT will be returned in the output as it is"},"dates":{"type":"array","description":"Dates for session (only for ILT)","items":{"$ref":"#/definitions/LearnEnrollmentBatchImportDates"}},"assignment_type":{"description":"Assignment Type enrollment attribute. Can be passed only when the attribute is configured in the platform advanced settings. The possible values are "mandatory", "required", "recommended", "optional" but to be accepted they must be enabled in the settings. This parameter is optional.","enum":["mandatory","required","recommended","optional"],"type":"string"}}},"LearnEnrollmentBatchImportDates":{"required":["date","present","effective_duration"],"properties":{"date":{"type":"string","description":"Date from session (e.g "2018-05-31")"},"present":{"type":"boolean","description":"Indicates if the user was present at the session date. If set to true, the user attendance is set to "Present" for this event of the session. It is ignored otherwise."},"effective_duration":{"type":"integer","description":"Effective duration in minutes for session date."}}},"LearnEnrollmentBatchImportOptions":{"properties":{"timezone":{"type":"string","description":"It applies to all enrollments that don’t have a time zone defined"},"enroll_disabled_users":{"type":"boolean","description":"Allow enrollments for deactivated and expired users. This can be used only by SuperAdmins."},"duplicates_as_recertification":{"type":"boolean","description":"If set to true, consider duplicate enrollments as recertification records. This is considered only when there is no reference to a session in input"},"course_id":{"type":"integer","description":"If it is set, it has higher priority over 'course_code' and 'course_id' sent outside these 'options' object"},"session_id":{"type":"integer","description":"If it is set, it has higher priority over 'session_code' and 'session_id' sent outside these 'options' object"},"enable_waitinglist":{"type":"boolean","description":"In case the waiting list parameter is turned 'true', the course waiting list needs to be respected, otherwise not. Default - 'false'"},"enrollment_date_now":{"type":"boolean","description":"In case this parameter is turned 'true', Enrollment Date will be set to 'now'. Default - 'false'"},"status":{"description":"If it is set, it has higher priority over 'status' sent outside these 'options' object. This field is required if NOT set inside the 'items' objects.","enum":["subscribed","in_progress","completed","waiting","to_confirm","suspended"],"type":"string"},"level":{"description":"Enrollment level, "student" and "learner" are identical. For new ILT courses, The instructors can not be enrolled.","enum":["student","tutor","instructor","coach","learner"],"type":"string"},"active_from":{"type":"string","description":"Start date of the enrollment. (YYYY-MM-DD HH:MM:SS e.g "2019-06-30 12:00:00")"},"active_until":{"type":"string","description":"Expiry date of the enrollment (YYYY-MM-DD HH:MM:SSe.g "2015-06-30 12:00:00")"},"trigger_notifications":{"type":"boolean","description":"Trigger notifications when saving/updating user enrollments. Not related to the digest_notification_ids parameter. Default: true"},"trigger_certifications":{"type":"boolean","description":"Trigger certifications generation when saving/updating user enrollments. Default: true"},"assignment_type":{"type":"enum('mandatory', 'required', 'recommended', 'optional', null)","description":"Assignment Type enrollment attribute. Can be passed only when the attribute is configured in the platform advanced settings. The possible values are "mandatory", "required", "recommended", "optional" but to be accepted they must be enabled in the settings. This parameter is optional."},"digest_notification_ids":{"type":"array","description":"Ids of notifications to trigger. This option is not related to the trigger_notifications parameter","items":{"$ref":"#/definitions/LearnEnrollmentBatchImportDigestNotificationIds"}},"additional_field_category_validation":{"type":"boolean","description":"If set to false, it skips category validation of additional fields incompatible with the course category and does not set them on the resulting enrollment. Default - 'true'"}}},"LearnEnrollmentBatchImportDigestNotificationIds":{},"LearnEnrollmentBatchImportResponse":{"required":["data","version","version","version","_links","version","permissions","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnEnrollmentBatchImportData"}},"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/LearnEnrollmentBatchImportLinks"}},"permissions":{"type":"array","description":"List of numeric permissions for the currently retrieved resource (e.g. course, learning plan)","items":{"$ref":"#/definitions/LearnEnrollmentBatchImportPermissions"}}}},"LearnEnrollmentBatchImportData":{"required":["row_index","success","course_id","user_id"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Status message (if any)"},"batch_item_id":{"type":"integer","description":"Item ID if its provided from the input params"},"course_id":{"type":"integer","description":"Course ID"},"user_id":{"type":"integer","description":"User ID"},"session_id":{"type":"integer","description":"Session ID"},"error_code":{"type":"string","description":"Error Code"}}},"LearnEnrollmentBatchImportLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentBatchImportSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentBatchImportGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentBatchImportFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentBatchImportLast","description":"Link to the last page"}}},"LearnEnrollmentBatchImportSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentBatchImportGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentBatchImportFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentBatchImportLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentBatchImportPermissions":{},"LearnEnrollmentDuplicateSchema":{"type":"object","required":["from_course","to_course"],"properties":{"from_course":{"type":"integer","description":"ID of the course to copy the enrollment from"},"to_course":{"type":"integer","description":"ID of the course to copy the enrollment to"},"from_session":{"type":"integer","description":"ID of the session to copy the enrollment from (it's mandatory if is provided to_session)"},"to_session":{"type":"integer","description":"ID of the session to copy the enrollment to (it's mandatory if is provided from_session)"},"reset_enrollments":{"type":"boolean","description":"If "false" (or not provided) the enrollment status gets copied, if "true" the enrollment is resetted to "subscribed" status"},"reset_deadline":{"type":"boolean","description":"If "false" (or not provided), the deadline is copied from the "from" course, else is calculated based on the new course configuration"},"exclude_course_waiting_list_users":{"type":"boolean","description":"If false, all course enrollments will be copied from the original source to the new one, otherwise course enrollments in Waiting list status are not copied. This param is not considered for sessions enrollments duplication."}}},"LearnEnrollmentDuplicateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentDuplicateData","description":"Results of the enroll process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentDuplicateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentDuplicateData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Success or failure to duplicate enrollments between courses"},"message":{"type":"array","description":"Array with errors","items":{"$ref":"#/definitions/LearnEnrollmentDuplicateMessage"}},"existing_enrollments_user_ids":{"type":"array","description":"Users that already enrolled to the course to copy the enrollment to","items":{"type":"string"}}}},"LearnEnrollmentDuplicateMessage":{"required":["message"],"properties":{"message":{"type":"string","description":"Error message"}}},"LearnEnrollmentDuplicateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentDuplicateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentDuplicateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentDuplicateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentDuplicateLast","description":"Link to the last page"}}},"LearnEnrollmentDuplicateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentDuplicateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentDuplicateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentDuplicateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentDeleteSessionResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentDeleteSessionData","description":"Results of the enroll process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentDeleteSessionLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnEnrollmentDeleteSessionData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Returns if request succeed or not"},"error_message":{"type":"string","description":"If the request is successful error_message wont be returned"}}},"LearnEnrollmentDeleteSessionLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentDeleteSessionSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentDeleteSessionGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentDeleteSessionFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentDeleteSessionLast","description":"Link to the last page"}}},"LearnEnrollmentDeleteSessionSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentDeleteSessionGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentDeleteSessionFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentDeleteSessionLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentPendingUsersResponse":{"required":["data","version","version","version","_links","version","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentPendingUsersData","description":"API result"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnEnrollmentPendingUsersLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"},"cursor":{"type":"string","description":"The cursor (only if get_cursor is specified)"}}},"LearnEnrollmentPendingUsersData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of pending user enrollments","items":{"$ref":"#/definitions/LearnEnrollmentPendingUsersItems"}},"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/LearnEnrollmentPendingUsersSort"}}}},"LearnEnrollmentPendingUsersItems":{"required":["user_id","username","course_id","course_name","course_type","subscription_date","session_id"],"properties":{"user_id":{"type":"integer","description":"Internal user ID"},"username":{"type":"string","description":"Username"},"course_id":{"type":"integer","description":"Internal course ID"},"course_name":{"type":"string","description":"Course name"},"course_type":{"description":"The type of the course, for which the enrollment is pending","enum":["elearning","classroom"],"type":"string"},"subscription_date":{"type":"string","description":"Date when user subscribed to course."},"session_id":{"type":"integer","description":"Session ID. Can be null"}}},"LearnEnrollmentPendingUsersSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnEnrollmentPendingUsersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnEnrollmentPendingUsersSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnEnrollmentPendingUsersGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnEnrollmentPendingUsersFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnEnrollmentPendingUsersLast","description":"Link to the last page"}}},"LearnEnrollmentPendingUsersSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnEnrollmentPendingUsersGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnEnrollmentPendingUsersFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnEnrollmentPendingUsersLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnEnrollmentImporterFieldsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnEnrollmentImporterFieldsData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnEnrollmentImporterFieldsData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/LearnEnrollmentImporterFieldsFields"}}}},"LearnEnrollmentImporterFieldsFields":{},"LearnEnrollmentBatchUnenrollSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array containing objects of values to be imported","items":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollItems"}},"options":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollOptions","description":"Object containing additional options."}}},"LearnEnrollmentBatchUnenrollItems":{"properties":{"course_code":{"type":"string","description":"The code of the course. It becomes 'required' if is not provided 'course_id' or 'course_id' in 'options'"},"course_id":{"type":"integer","description":"The numeric ID of the course in the LMS. It becomes 'required' if is not provided 'course_code' or 'course_id' in 'options'"},"session_code":{"type":"string","description":"The code of the session"},"session_id":{"type":"integer","description":"The ID of the session"},"username":{"type":"string","description":"The LMS username of the user. It becomes 'required' if is not provided 'user_id'"},"user_id":{"type":"integer","description":"The numeric ID of the user in the LMS. It becomes 'required' if is not provided 'username'"},"batch_item_id":{"type":"string","description":"Client-specified ID for the current batch item. IT will be returned in the output as it is"}}},"LearnEnrollmentBatchUnenrollOptions":{"properties":{"course_id":{"type":"integer","description":"If it is set, it has higher priority over 'course_code' and 'course_id' sent outside these 'options' object"},"session_id":{"type":"integer","description":"If it is set, it has higher priority over 'session_code' and 'session_id' sent outside these 'options' object"}}},"LearnEnrollmentBatchUnenrollResponse":{"required":["data","version","version","version","_links","version","permissions","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Always empty","items":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollLinks"}},"permissions":{"type":"array","description":"List of numeric permissions for the currently retrieved resource (e.g. course, learning plan)","items":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollPermissions"}}}},"LearnEnrollmentBatchUnenrollData":{"required":["row_index","success","message","course_id","user_id","username"],"properties":{"row_index":{"type":"integer","description":"Index of the row"},"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Status message"},"error_code":{"type":"integer","description":"The error code of the message. "1" when a general error, "2" when user is assigned to LP"},"batch_item_id":{"type":"integer","description":"Item ID if it's provided from the input params"},"course_id":{"type":"integer","description":"Course ID"},"user_id":{"type":"integer","description":"User ID"},"username":{"type":"string","description":"Username"},"session_id":{"type":"integer","description":"Session ID"}}},"LearnEnrollmentBatchUnenrollLinks":{},"LearnEnrollmentBatchUnenrollPermissions":{},"LearnEnrollmentBatchUnenrollSessionSchema":{"type":"object","required":["items","options"],"properties":{"items":{"type":"array","description":"Array containing objects of values to be imported","items":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollSessionItems"}},"options":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollSessionOptions","description":"Object containing additional options."}}},"LearnEnrollmentBatchUnenrollSessionItems":{"required":["user_id"],"properties":{"user_id":{"type":"integer","description":"The user ID to perform the un-enroll"}}},"LearnEnrollmentBatchUnenrollSessionOptions":{"required":["session_id"],"properties":{"session_id":{"type":"integer","description":"The session ID to perform the un-enroll"}}},"LearnEnrollmentBatchUnenrollSessionResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"The API result","items":{"$ref":"#/definitions/LearnEnrollmentBatchUnenrollSessionData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnEnrollmentBatchUnenrollSessionData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"true if the request has been successful"},"message":{"type":"string","description":"optional message detailing the result"}}},"LearnExternaltrainingCreateSchema":{"type":"object","required":["course_type","to_date"],"properties":{"course_type":{"description":"Course type","enum":["elearning","classroom"],"type":"string"},"course_name":{"type":"string","description":"Course name"},"course_id":{"type":"integer","description":"Course ID"},"from_date":{"type":"string","format":"date","description":"Start date of the training. Only required when course type is classroom."},"to_date":{"type":"string","format":"date","description":"End date of the training"},"id_user":{"type":"string","description":"One of the three user identifiers of active and valid users should be presented"},"username":{"type":"string","description":"One of the three user identifiers of active and valid users should be presented"},"uuid":{"type":"string","description":"One of the three user identifiers of active and valid users should be presented"},"score":{"type":"string","description":"Score of the training"},"credits":{"type":"string","description":"Credits given"},"training_institute":{"type":"string","description":"Training institute - name of the training institute (should be presented if training_institute_code is empty)"},"training_institute_code":{"type":"string","description":"Training institute code - id of the training institute (should be presented if training_institute is empty)"},"certificate":{"type":"string","description":"Data URL with the content of a base64 file for the certificate."},"certificate_filename":{"type":"string","description":"Custom name (without extension) for the certificate (max 512 chars, default: a random string). It requires the certificate field to be specified."},"certification":{"type":"integer","description":"Certification ID"},"additional_fields":{"$ref":"#/definitions/LearnExternaltrainingCreateAdditionalFields","description":"Key is the ID of the additional field, value is the value e.g. "additional_fields": {"6":"some text"}"}}},"LearnExternaltrainingCreateAdditionalFields":{},"LearnExternaltrainingCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnExternaltrainingCreateData","description":"Object containing the result status"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources","items":{"$ref":"#/definitions/LearnExternaltrainingCreateLinks"}}}},"LearnExternaltrainingCreateData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"status of the operation"},"error":{"$ref":"#/definitions/LearnExternaltrainingCreateError","description":"Error information, if any"},"id_record":{"type":"integer","description":"ID of the record"},"message":{"type":"array","description":"Message of the operation","items":{"$ref":"#/definitions/LearnExternaltrainingCreateMessage"}}}},"LearnExternaltrainingCreateError":{"required":["errorCode","message"],"properties":{"errorCode":{"type":"integer","description":"Code of the error"},"message":{"type":"string","description":"Message of the error"}}},"LearnExternaltrainingCreateMessage":{},"LearnExternaltrainingCreateLinks":{},"LearnExternaltrainingDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnExternaltrainingDeleteData","description":"Success or failure"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnExternaltrainingDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnExternaltrainingDeleteData":{"required":["success","deleted_external_training_id"],"properties":{"success":{"type":"boolean","description":"Success or failure to delete user"},"deleted_external_training_id":{"type":"integer","description":"ID of deleted external training"},"errorMessage":{"type":"string","description":"Error message"},"errorCode":{"type":"integer","description":"Error code of the error"}}},"LearnExternaltrainingDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnExternaltrainingDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnExternaltrainingDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnExternaltrainingDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnExternaltrainingDeleteLast","description":"Link to the last page"}}},"LearnExternaltrainingDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnExternaltrainingDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnExternaltrainingDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnExternaltrainingDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnExternaltrainingIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnExternaltrainingIndexData","description":"Response success or failure to find External training"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnExternaltrainingIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnExternaltrainingIndexData":{"properties":{"items":{"type":"array","description":"List of External trainings","items":{"$ref":"#/definitions/LearnExternaltrainingIndexItems"}},"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. Can be null"},"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/LearnExternaltrainingIndexSort"}}},"required":["count","has_more_data","cursor","current_page","current_page_size"]},"LearnExternaltrainingIndexItems":{"required":["training_id","user_id","username","uuid","training_institute_code","training_institute","course_code","course_name","course_type","from_date","to_date","score","CEUs","certification","certificate","additional_fields"],"properties":{"training_id":{"type":"integer","description":"The ID of the external training (transcripts record)"},"user_id":{"type":"integer","description":"The ID of the user"},"username":{"type":"string","description":"Username of the user"},"uuid":{"type":"string","description":"UUID of the user"},"training_institute_code":{"type":"integer","description":"ID of the training_institute, return 'NULL' in case doesn't exist training_institute record"},"training_institute":{"type":"string","description":"Name of institute."},"course_code":{"type":"integer","description":"ID of transcripts_course, return 'NULL' in case doesn't exist transcripts_course record"},"course_name":{"type":"string","description":"Name of course"},"course_type":{"description":"Type of course","enum":["elearning","classroom"],"type":"string"},"from_date":{"type":"string","format":"date","description":"From date of the external training (transcripts record)"},"to_date":{"type":"string","format":"date","description":"To date of the external training (transcripts record)"},"score":{"type":"integer","description":"Score of the external training (transcripts record)"},"CEUs":{"type":"integer","description":"Credits (CEUs) of the external training (transcripts record)"},"certification":{"type":"string","description":"Id of the certification assigned. Can be null"},"certificate":{"type":"string","description":"Path of the certificate assigned. Can be null"},"additional_fields":{"type":"array","description":"Additional fields and their values for this external training","items":{"$ref":"#/definitions/LearnExternaltrainingIndexAdditionalFields"}}}},"LearnExternaltrainingIndexAdditionalFields":{"required":["id","title","type","value"],"properties":{"id":{"type":"integer","description":"ID of the additional field"},"title":{"type":"string","description":"Translated name of the additional field"},"type":{"type":"string","description":"Type of the additional field"},"value":{"type":"string","description":"The value for this additional field for the external training"}}},"LearnExternaltrainingIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnExternaltrainingIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnExternaltrainingIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnExternaltrainingIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnExternaltrainingIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnExternaltrainingIndexLast","description":"Link to the last page"}}},"LearnExternaltrainingIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnExternaltrainingIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnExternaltrainingIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnExternaltrainingIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnExternaltrainingUpdateSchema":{"type":"object","properties":{"status":{"description":"Status of the training (accepted,rejected or waiting_approval)","enum":["approved","waiting","rejected"],"type":"string"},"course_type":{"description":"Course type","enum":["elearning","classroom"],"type":"string"},"course_name":{"type":"string","description":"Course name"},"course_id":{"type":"integer","description":"Course ID"},"from_date":{"type":"string","description":"Start date of the training. Only required when course type is classroom."},"to_date":{"type":"string","description":"End date of the training"},"score":{"type":"string","description":"Score of the training"},"credits":{"type":"string","description":"Credits given"},"training_institute":{"type":"string","description":"Training institute - name of the training institute"},"training_institute_code":{"type":"string","description":"Training institute code - id of the training institute"},"certificate":{"type":"string","description":"Data URL with the content of a base64 file for the certificate."},"certificate_filename":{"type":"string","description":"Custom name (without extension) for the certificate (max 512 chars, default: a random string). It requires the certificate field to be specified."},"certification":{"type":"integer","description":"Certification ID"},"id_user":{"type":"integer","description":"User ID of active and valid users"},"username":{"type":"string","description":"Username of active and valid users"},"uuid":{"type":"integer","description":"User UUID of active and valid users"},"approved_by":{"type":"integer","description":"ID of admin that approves if status is approved or rejected"},"additional_fields":{"$ref":"#/definitions/LearnExternaltrainingUpdateAdditionalFields","description":"Key is the ID of the additional field, value is the value e.g. "additional_fields": {"6":"some text"}"}}},"LearnExternaltrainingUpdateAdditionalFields":{},"LearnExternaltrainingUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnExternaltrainingUpdateData","description":"ID of the updated training"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnExternaltrainingUpdateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnExternaltrainingUpdateData":{"required":["id","success"],"properties":{"id":{"type":"integer","description":"The internal ID for the updated external training"},"success":{"type":"boolean","description":"Status of the operation"},"error":{"$ref":"#/definitions/LearnExternaltrainingUpdateError","description":"Error information"},"message":{"type":"string","description":"Message of the operation"}}},"LearnExternaltrainingUpdateError":{"required":["errorCode","message"],"properties":{"errorCode":{"type":"integer","description":"Error code"},"message":{"type":"string","description":"Message of the error"}}},"LearnExternaltrainingUpdateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnExternaltrainingUpdateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnExternaltrainingUpdateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnExternaltrainingUpdateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnExternaltrainingUpdateLast","description":"Link to the last page"}}},"LearnExternaltrainingUpdateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnExternaltrainingUpdateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnExternaltrainingUpdateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnExternaltrainingUpdateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnExternaltrainingViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnExternaltrainingViewData","description":"Success or failure to find external training (transcripts_record)"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnExternaltrainingViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnExternaltrainingViewData":{"required":["id","training_id","user_id","username","uuid","training_institute_code","training_institute","course_code","course_name","course_type","from_date","to_date","score","CEUs","additional_fields"],"properties":{"id":{"type":"integer","description":"ID of the course"},"training_id":{"type":"integer","description":"The ID of the external training (transcripts record)"},"user_id":{"type":"integer","description":"The ID of the user"},"username":{"type":"string","description":"Username of the user"},"uuid":{"type":"string","description":"UUID of the user"},"training_institute_code":{"type":"integer","description":"ID of the training_institute, return 'NULL' in case doesn't exist training_institute record"},"training_institute":{"type":"string","description":"Name of institute."},"course_code":{"type":"integer","description":"ID of transcripts_course, return 'NULL' in case doesn't exist transcripts_course record"},"course_name":{"type":"string","description":"Name of course"},"course_type":{"description":"Type of course","enum":["elearning","classroom"],"type":"string"},"from_date":{"type":"string","format":"date","description":"From date of the external training (transcripts record)"},"to_date":{"type":"string","format":"date","description":"To date of the external training (transcripts record)"},"score":{"type":"integer","description":"Score of the external training (transcripts record)"},"CEUs":{"type":"integer","description":"Credits (CEUs) of the external training (transcripts record) *"},"additional_fields":{"type":"array","description":"Additional fields and their values for this external training","items":{"$ref":"#/definitions/LearnExternaltrainingViewAdditionalFields"}}}},"LearnExternaltrainingViewAdditionalFields":{"required":["id","title","type","value"],"properties":{"id":{"type":"integer","description":"ID of the additional field"},"title":{"type":"string","description":"Translated name of the additional field"},"type":{"type":"string","description":"Type of the additional field"},"value":{"type":"string","description":"The value for this additional field for the external training"}}},"LearnExternaltrainingViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnExternaltrainingViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnExternaltrainingViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnExternaltrainingViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnExternaltrainingViewLast","description":"Link to the last page"}}},"LearnExternaltrainingViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnExternaltrainingViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnExternaltrainingViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnExternaltrainingViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnExternaltrainingBatchImportSchema":{"type":"object","required":["batch_data"],"properties":{"batch_data":{"type":"array","description":"Batch data","items":{"$ref":"#/definitions/LearnExternaltrainingBatchImportBatchData"}}}},"LearnExternaltrainingBatchImportBatchData":{"required":["course_type","from_date"],"properties":{"course_type":{"type":"string","description":"Course type - elearning or classroom"},"from_date":{"type":"string","format":"date","description":"From date. The valid format is Y-m-d (e.g. 2010-12-27)"},"to_date":{"type":"string","format":"date","description":"To date. The valid format is Y-m-d (e.g. 2010-12-27)"},"score":{"type":"integer","description":"Score of the training"},"credits":{"type":"number","format":"float","description":"Credits given"},"training_institute":{"type":"string","description":"Training institute (required if not provided training_institute_code OR setting "Require users to select training institute and courses from defined list" is 'OFF')"},"training_institute_code":{"type":"string","description":"Training institute (required if not provided training_institute)"},"certification":{"type":"integer","description":"Id of the existing certification to assign"},"certificate":{"type":"string","description":"Data URL with the content of a base64 file for the certificate."},"certificate_filename":{"type":"string","description":"Custom name (without extension) for the certificate (max 512 chars, default: a random string). It requires the certificate field to be specified."},"course_id":{"type":"integer","description":"Course ID (required if not provided course_name)"},"course_name":{"type":"string","description":"Course name (required if not provided course_id OR setting "Require users to select training institute and courses from defined list" is 'OFF')"},"id_user":{"type":"integer","description":"User ID (required if not provided username or uuid)"},"username":{"type":"string","description":"Username (required if not provided user_id or uuid)"},"uuid":{"type":"string","description":"UUID (required if not provided user_id or username)"},"additional_fields":{"type":"string","description":"Additional fields - example: 'additional_fields': {'1': 'val1', '2': 'val2'}"}}},"LearnExternaltrainingBatchImportResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response","items":{"$ref":"#/definitions/LearnExternaltrainingBatchImportData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnExternaltrainingBatchImportLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnExternaltrainingBatchImportData":{"required":["row_index","success","message"],"properties":{"row_index":{"type":"integer","description":"Index of the processed row"},"success":{"type":"boolean","description":"status of the operation"},"message":{"type":"string","description":"Message of the operation"}}},"LearnExternaltrainingBatchImportLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnExternaltrainingBatchImportSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnExternaltrainingBatchImportGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnExternaltrainingBatchImportFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnExternaltrainingBatchImportLast","description":"Link to the last page"}}},"LearnExternaltrainingBatchImportSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnExternaltrainingBatchImportGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnExternaltrainingBatchImportFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnExternaltrainingBatchImportLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnExternaltrainingBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Batch data","items":{"$ref":"#/definitions/LearnExternaltrainingBatchItems"}}}},"LearnExternaltrainingBatchItems":{"required":["course_type","from_date"],"properties":{"course_type":{"type":"string","description":"Course type - elearning or classroom"},"from_date":{"type":"string","format":"date","description":"From date. The valid format is Y-m-d (e.g. 2010-12-27)"},"to_date":{"type":"string","format":"date","description":"To date. The valid format is Y-m-d (e.g. 2010-12-27)"},"score":{"type":"integer","description":"Score of the training"},"credits":{"type":"number","format":"float","description":"Credits given"},"training_institute":{"type":"string","description":"Training institute (required if not provided training_institute_code OR setting "Require users to select training institute and courses from defined list" is 'OFF')"},"training_institute_code":{"type":"string","description":"Training institute (required if not provided training_institute)"},"certification":{"type":"integer","description":"Id of the existing certification to assign"},"certificate":{"type":"string","description":"Data URL with the content of a base64 file for the certificate."},"certificate_filename":{"type":"string","description":"Custom name (without extension) for the certificate (max 512 chars, default: a random string). It requires the certificate field to be specified."},"course_id":{"type":"integer","description":"Course ID (required if not provided course_name)"},"course_name":{"type":"string","description":"Course name (required if not provided course_id OR setting "Require users to select training institute and courses from defined list" is 'OFF')"},"id_user":{"type":"integer","description":"User ID (required if not provided username or uuid)"},"username":{"type":"string","description":"Username (required if not provided user_id or uuid)"},"uuid":{"type":"string","description":"UUID (required if not provided user_id or username)"},"additional_fields":{"type":"string","description":"Additional fields - example: 'additional_fields': {'1': 'val1', '2': 'val2'}"}}},"LearnExternaltrainingBatchResponse":{"required":["version","version","_links","version","response","version","row_index","version","version","message","version","success","version"],"properties":{"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnExternaltrainingBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"},"response":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnExternaltrainingBatchResponseL2"}},"row_index":{"type":"integer","description":"Import ID for the current record"},"id_record":{"type":"integer","description":"The ID of the generated record (if generated)"},"message":{"type":"string","description":"Optional error message"},"success":{"type":"boolean","description":"Could the record be properly imported?"}}},"LearnExternaltrainingBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnExternaltrainingBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnExternaltrainingBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnExternaltrainingBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnExternaltrainingBatchLast","description":"Link to the last page"}}},"LearnExternaltrainingBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnExternaltrainingBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnExternaltrainingBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnExternaltrainingBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnExternaltrainingBatchResponseL2":{},"LearnForumGetForumDataResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnForumGetForumDataData","description":"list of forums"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnForumGetForumDataLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnForumGetForumDataData":{"required":["forums"],"properties":{"forums":{"type":"array","description":"an array of forums","items":{"$ref":"#/definitions/LearnForumGetForumDataForums"}}}},"LearnForumGetForumDataForums":{"required":["ID","FORUM","DISCUSSIONS","POSTS"],"properties":{"ID":{"type":"integer","description":"ID of the forum"},"FORUM":{"type":"string","description":"Forum name"},"DISCUSSIONS":{"type":"integer","description":"Number of discussions"},"POSTS":{"type":"integer","description":"Number of posts"}}},"LearnForumGetForumDataLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnForumGetForumDataSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnForumGetForumDataGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnForumGetForumDataFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnForumGetForumDataLast","description":"Link to the last page"}}},"LearnForumGetForumDataSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnForumGetForumDataGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnForumGetForumDataFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnForumGetForumDataLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnIltGetMultipleIltSessionsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsData","description":""},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS. Can be an empty array is get_cursor is passed with value 0."}}},"LearnIltGetMultipleIltSessionsData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of ilt session enrollments data","items":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsItems"}},"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":"Data set navigational cursor previously obtained by either not passing get_cursor or passing it with value 1. It will be null if get_cursor is passed with value 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"},"sort":{"type":"array","description":"Array of applied sorting fields","items":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsSort"}}}},"LearnIltGetMultipleIltSessionsItems":{"required":["session_id","user_id","username","firstname","lastname","level","status","enrollment_date","course_id","course_status","course_enrollment_date"],"properties":{"session_id":{"type":"integer","description":"Session ID"},"user_id":{"type":"integer","description":"User ID"},"username":{"type":"string","description":"Username"},"firstname":{"type":"string","description":"User’s firstname"},"lastname":{"type":"string","description":"User’s lastname"},"level":{"description":"Enrollment level for this user in the course","enum":["learner","instructor","tutor","coach"],"type":"string"},"status":{"description":"Enrollment status in the session","enum":["subscribed","in_progress","completed","subscription_to_confirm","waiting","suspended"],"type":"string"},"enrollment_date":{"type":"string","format":"date","description":"Session level enrollment date in UTC yyyy-MM-dd HH:mm:ss"},"completion_date":{"type":"string","format":"date","description":"Session level completion date in UTC yyyy-MM-dd HH:mm:ss"},"course_id":{"type":"integer","description":"Course ID"},"course_status":{"description":"Enrollment status in the course","enum":["subscribed","in_progress","completed","subscription_to_confirm","waiting","suspended","overbooking"],"type":"string"},"course_final_score":{"type":"number","format":"float","description":"Course level score value"},"course_enrollment_date":{"type":"string","format":"date","description":"Course level enrollment date in UTC yyyy-MM-dd HH:mm:ss"},"course_completion_date":{"type":"string","format":"date","description":"Course level completion date in UTC yyyy-MM-dd HH:mm:ss"},"attendance":{"type":"array","description":"Array of days the current user has been marked as attended","items":{"type":"string"}},"attendance_status":{"type":"array","description":"Array of attendance statuses (present, absent, not set) of the days the current user has been marked as attended","items":{"type":"string"}},"evaluation_status":{"description":"Whether this user has been marked as passed or failed in the current session","enum":["passed","failed"],"type":"string"},"evaluation_score":{"type":"number","format":"float","description":"Score entered by evaluator"},"evaluation_comment":{"type":"string","description":"Evaluator comment"},"evaluation_date":{"type":"string","format":"date","description":"Evaluation date in UTC yyyy-MM-dd HH:mm:ss"},"evaluator_id":{"type":"integer","description":"User ID of the evaluator"}}},"LearnIltGetMultipleIltSessionsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnIltGetMultipleIltSessionsLinks":{"properties":{"self":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsSelf","description":"Link to the current page"},"next":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsNext","description":"Link to the next page"},"goto":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnIltGetMultipleIltSessionsLast","description":"Link to the last page"}}},"LearnIltGetMultipleIltSessionsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnIltGetMultipleIltSessionsNext":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the next page"}}},"LearnIltGetMultipleIltSessionsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnIltGetMultipleIltSessionsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnIltGetMultipleIltSessionsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnInstructorGetInstructorDataResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnInstructorGetInstructorDataData","description":"List of instuctors"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnInstructorGetInstructorDataLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnInstructorGetInstructorDataData":{"required":["instructors"],"properties":{"instructors":{"type":"array","description":"Array of instructors. Indexed by firstname, then lastname","items":{"$ref":"#/definitions/LearnInstructorGetInstructorDataInstructors"}}}},"LearnInstructorGetInstructorDataInstructors":{"properties":{"idst":{"type":"integer","description":"Inter ID of the user"},"userid":{"type":"string","description":"Internal username of the user"},"firstname":{"type":"string","description":"First name of the user"},"lastname":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"E-mail address of the user"},"avatar":{"type":"string","description":"Avatar Amazon S3 filename"},"urlAvatar":{"type":"string","description":"Avatar URL of the user"}}},"LearnInstructorGetInstructorDataLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnInstructorGetInstructorDataSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnInstructorGetInstructorDataGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnInstructorGetInstructorDataFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnInstructorGetInstructorDataLast","description":"Link to the last page"}}},"LearnInstructorGetInstructorDataSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnInstructorGetInstructorDataGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnInstructorGetInstructorDataFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnInstructorGetInstructorDataLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnInstructorAssignmentsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnInstructorAssignmentsData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnInstructorAssignmentsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnInstructorAssignmentsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of assignments","items":{"$ref":"#/definitions/LearnInstructorAssignmentsItems"}},"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/LearnInstructorAssignmentsSort"}}}},"LearnInstructorAssignmentsItems":{"required":["id","name","slug_name","course_name","course_type","id_course","id_lo"],"properties":{"id":{"type":"integer","description":"Internal ID of the submitted assignment"},"name":{"type":"string","description":"Given name of the submitted assignment"},"slug_name":{"type":"string","description":"The SEO friendly name of this assignment, to be used in URLs or as a URI"},"course_name":{"type":"string","description":"Name of the course where assignment is stored"},"course_type":{"description":"The type of the course","enum":["elearning","classroom"],"type":"string"},"id_course":{"type":"integer","description":"Internal ID of the course"},"id_lo":{"type":"integer","description":"Internal ID of the learning organization"},"score":{"type":"integer","description":"Assigned score when assignment is evaluated"},"status":{"type":"integer","description":"Status of evaluation: 1 - passed; 0 - not evaluated; -1 - failed"},"level":{"type":"string","description":"Level of user enrollment"}}},"LearnInstructorAssignmentsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnInstructorAssignmentsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnInstructorAssignmentsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnInstructorAssignmentsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnInstructorAssignmentsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnInstructorAssignmentsLast","description":"Link to the last page"}}},"LearnInstructorAssignmentsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnInstructorAssignmentsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnInstructorAssignmentsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnInstructorAssignmentsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLoViewData","description":"Information about the learning object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoViewData":{"required":["id","idResource","title","description","short_description","visible","objectType","idCourse","thumbnail"],"properties":{"id":{"type":"integer","description":"Unique ID of the learning object"},"idResource":{"type":"integer","description":"Unique ID of the resource of the learning object"},"title":{"type":"string","description":"Name of the learning object"},"description":{"type":"string","description":"Description of the learning object"},"short_description":{"type":"string","description":"Short description of the learning object"},"visible":{"type":"boolean","description":"Is the learning object visible"},"objectType":{"type":"string","description":"Type of the learning object"},"idCourse":{"type":"integer","description":"Type id of the course of the learning object"},"thumbnail":{"type":"string","description":"The url of the thumbnail of the learning object if exists"}}},"LearnLoViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLoViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLoViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLoViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLoViewLast","description":"Link to the last page"}}},"LearnLoViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLoViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLoViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLoViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoPlayResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLoPlayData","description":"Response Data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoPlayLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoPlayData":{"properties":{"launch_params":{"$ref":"#/definitions/LearnLoPlayLaunchParams","description":"LO launch parameters"}}},"LearnLoPlayLaunchParams":{},"LearnLoPlayLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLoPlaySelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLoPlayGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLoPlayFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLoPlayLast","description":"Link to the last page"}}},"LearnLoPlaySelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLoPlayGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLoPlayFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLoPlayLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoTrackSchema":{"type":"object","properties":{"track":{"$ref":"#/definitions/LearnLoTrackTrack","description":"Attributes based on the given LO type"},"context":{"description":"The context in which the learning object is being tracked. Default is 'lms'.","enum":["lms","golearn","flow","flow_msteams","browser_extension"],"type":"string"}}},"LearnLoTrackTrack":{},"LearnLoTrackResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLoTrackData","description":"Response Data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoTrackLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoTrackData":{"properties":{"acknowledge":{"$ref":"#/definitions/LearnLoTrackAcknowledge","description":"Attributes based on the given LO type"}}},"LearnLoTrackAcknowledge":{},"LearnLoTrackLinks":{},"LearnLoBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects with data to be imported","items":{"$ref":"#/definitions/LearnLoBatchItems"}},"options":{"$ref":"#/definitions/LearnLoBatchOptions","description":""}}},"LearnLoBatchItems":{"properties":{"course_id":{"type":"integer","description":"The id of the course placeholder where the training material is going to be created. Required if course_code is empty"},"course_code":{"type":"string","description":"The code of the course placeholder where the training material is going to be created. Required if course_id is empty"},"lo_code":{"type":"string","description":"Code of the learning object."},"lo_name":{"type":"string","description":"The name of the training material (supposed to be unique inside the course)."},"lo_type":{"description":"Identifies the type of object contained in the current row. The "dli" type is only available when RELEASE/WEEKLY/DLI-AS-TRAINING-MATERIAL toggle is ON.","enum":["scorm","file","video","tincan","aicc","html","test","slides_converter","dli"],"type":"string"},"lo_filename":{"type":"string","description":"(The attribute is required for all learning object types except for html): Filename complete with file extension which points to a shared physical file (f.e. scorm.zip)."},"lo_url":{"type":"string","description":"Url of the lo -> Mandatory only if filename is empty and lo_type is TinCan or Video. When the field is filled in, lo_filename must be empty. For TinCan if the entered URL matches an existing entry in XAPI external content, create the proper associations, including the SALT key (if defined)."},"lo_description":{"type":"string","description":"Extended description of the training material"},"lo_thumbnail":{"type":"string","description":"Training material thumbnail (only used in Player’s List View mode). It contains the filename of a shared image file, in jpg/png/gif formats."},"lo_content":{"type":"string","description":"Training material content (only applicable to html object type)"},"mobile_use_external_link":{"type":"boolean","description":"Can be used only when the external tin can play is enabled in the platform, the lo type is TinCan and the lo_url is filled in"},"lo_tincan_salt":{"type":"string","description":"Can be used only when the external tin can play is enabled in the platform, the lo type is TinCan and the lo_url is filled in. Define the SALT Secret Key for the External TinCan."},"lo_oauth_client":{"type":"string","description":"Can be used only when the external tin can play is enabled in the platform, the lo type is TinCan and the lo_url is filled in. ID of the OAuth client to be used to play the External TinCan."},"lo_enable_oauth":{"type":"boolean","description":"Can be used only when the external tin can play is enabled in the platform, the lo type is TinCan and the lo_url is filled in. Enable the OAuth client to play the External TinCan."},"lo_external_source_url":{"type":"string","description":"A public URL of the physical file associated with the Learning object. If the "options" object is set by the user it will be ignored."},"lo_track_all_activities":{"type":"boolean","description":"Can be used only when the external tin can play is enabled in the platform, the lo type is TinCan and the lo_url is filled in. Define if all activities of the LO should be tracked. Default value is TRUE."},"launch_mode":{"type":"string","description":"Set "in_line" to open the object inside the player, "lightbox" to open the object inside a Lightbox, "new_window" to open the object in a new window or new tab in your browser (depending on your browser settings), "fullscreen" to open the object in full screen. The parameters can be applied only for specific LO type, as follows: 1) SCORM - "lightbox", "fullscreen", "in_line", "new_window"; 2) Video - can not be applied; 3) TinCan - "lightbox", "in_line" and "new_window"; 4) File - can not be applied; 5) Slide - "lightbox"; 6) AICC - "lightbox", "fullscreen", "in_line", "new_window"; 7) HTML - can not be applied; 8) Test - can not be applied;"}},"required":["lo_name","lo_type"]},"LearnLoBatchOptions":{"properties":{"s3_key":{"type":"string","description":"Amazon S3 Key of the shared files location"},"s3_secret":{"type":"string","description":"Amazon S3 Secret of the shared files location"},"s3_region":{"type":"string","description":"Amazon S3 Region of the shared files location"},"s3_bucket_name":{"type":"string","description":"Amazon S3 Bucket Name of the shared files location"},"s3_root_folder":{"type":"string","description":"Amazon Root Folder of the shared files location (Do not indicate the s3 root folder as "/". Use "." instead)"},"unique_based_on_type":{"type":"boolean","description":"When this parameter is passed as true, the API would check if LO with name/code AND type already exists in given course. Default: false"}},"required":["s3_region"]},"LearnLoBatchResponse":{"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/LearnLoBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoBatchData":{"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"}}},"LearnLoBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLoBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLoBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLoBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLoBatchLast","description":"Link to the last page"}}},"LearnLoBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLoBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLoBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLoBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoBatchImportLoTrackingSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects with data to be imported. Maximum 100 items per batch.","items":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingItems"}},"options":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingOptions","description":""}}},"LearnLoBatchImportLoTrackingItems":{"properties":{"user_id":{"type":"number","description":"The user id. Required if username is not defined."},"username":{"type":"string","description":"The login name of an existing user in the LMS. Required if user_id is not defined."},"course_code":{"type":"string","description":"The course placeholder code. Required if lo_id is not defined."},"lo_id":{"type":"string","description":"Training material id. It's required if lo_code or lo_name are not defined"},"lo_name":{"type":"string","description":"The name of the training material which this tracking refers to. The name of the LO, it's required if lo_code is not defined."},"lo_code":{"type":"string","description":"Code of the learning object. The code of the LO, it's required if lo_name is not defined."},"lo_user_status":{"type":"string","description":"The user status for this training material. Options: subscribed, in progress, completed."},"lo_type":{"description":"One of the following values. The "dli" type is only available when RELEASE/WEEKLY/DLI-AS-TRAINING-MATERIAL toggle is ON.","enum":["scorm","file","video","tincan","html","assignment","test","dli"],"type":"string"},"lo_completion_date":{"type":"string","format":"date","description":"Course completion date (defaults to “now” = the time of the import). Format must be Y-m-d H:i:s (e.g. '2018-01-18 15:20:18')"},"lo_score":{"type":"number","description":"The final score taken by the user for the current training material (applicable only to scorm, tincan, assignment, test object types). The parameter accepts values of type float."},"lo_filename":{"type":"string","description":"The filename uploaded by the user (only applicable and it's mandatory to assignment objects). File name must contain extension."},"timezone":{"type":"string","description":"The timezone of the lo tracking in the form of Area/Location (i.e. Europe/Rome)"}},"required":["lo_user_status","lo_type"]},"LearnLoBatchImportLoTrackingOptions":{"properties":{"timezone":{"type":"string","description":"This will be used as items' timezone fallback. When item does not have timezone, this parameter will be used."}}},"LearnLoBatchImportLoTrackingResponse":{"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/LearnLoBatchImportLoTrackingData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoBatchImportLoTrackingData":{"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"}}},"LearnLoBatchImportLoTrackingLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLoBatchImportLoTrackingLast","description":"Link to the last page"}}},"LearnLoBatchImportLoTrackingSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLoBatchImportLoTrackingGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLoBatchImportLoTrackingFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLoBatchImportLoTrackingLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoTestsBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Array of objects with data to be imported","items":{"$ref":"#/definitions/LearnLoTestsBatchItems"}}}},"LearnLoTestsBatchItems":{"required":["course_code","object_title","type","question_title","answer_title","is_correct"],"properties":{"course_code":{"type":"string","description":"The code of the course placeholder where the test LO is going to be created"},"object_title":{"type":"string","description":"The name of the test (supposed to be unique inside the course)"},"object_code":{"type":"string","description":"The test LO code"},"type":{"type":"string","description":"Question type, it can be: 'break_page', 'choice', 'choice_multiple', 'extended_text','text_entry', 'title'"},"question_code":{"type":"string","description":"Question Code. The maximum allowed length is 100 characters"},"question_title":{"type":"string","description":"Question title. Mandatory, except for page_break"},"answer_title":{"type":"string","description":"Answer title. Mandatory only for choice, choice_multiple, text_entry"},"is_correct":{"type":"boolean","description":"Identifies if the answer is correct. Mandatory only for choice, choice_multiple"},"score_if_correct":{"type":"number","format":"double","description":"The score when the answer is correct"},"comment":{"type":"string","description":"Comment"}}},"LearnLoTestsBatchResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Result of operation","items":{"$ref":"#/definitions/LearnLoTestsBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLoTestsBatchData":{"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"}}},"LearnLoBatchResetTrackingSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Associative array containing key/value pairs to be imported","items":{"$ref":"#/definitions/LearnLoBatchResetTrackingItems"}},"options":{"$ref":"#/definitions/LearnLoBatchResetTrackingOptions","description":"Object containing additional options"}}},"LearnLoBatchResetTrackingItems":{"required":["lo_id","owner_type","owner_id"],"properties":{"lo_id":{"type":"integer","description":"The ID of the learning object, for which the tracking should be reset"},"owner_type":{"description":"For which user entity to reset the tracking data (either user, group or branch)","enum":["user","group","branch"],"type":"string"},"owner_id":{"type":"integer","description":"The ID of the user entity, which can refer to either the user, the group or the branch"},"agent_ids":{"type":"string","description":"The IDs of the user agent for lrs_reset"}}},"LearnLoBatchResetTrackingOptions":{"properties":{"reset_lrs":{"type":"boolean","description":"Whether to remove or not the data for the lrs in case of tincan objects. Default is "false""}}},"LearnLoBatchResetTrackingResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Response array","items":{"$ref":"#/definitions/LearnLoBatchResetTrackingData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoBatchResetTrackingLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoBatchResetTrackingData":{"required":["row_index","success"],"properties":{"row_index":{"type":"integer","description":"The index of the (LO - Owner) pair in the input parameters array"},"success":{"type":"boolean","description":"Was the tracking data for the (LO - Owner) pair, properly reset"},"message":{"type":"string","description":"Optional error message, if the operation was not successful"}}},"LearnLoBatchResetTrackingLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLoBatchResetTrackingSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLoBatchResetTrackingGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLoBatchResetTrackingFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLoBatchResetTrackingLast","description":"Link to the last page"}}},"LearnLoBatchResetTrackingSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLoBatchResetTrackingGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLoBatchResetTrackingFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLoBatchResetTrackingLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoDownloadResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLoDownloadData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoDownloadLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoDownloadData":{"required":["total_size","job_id","job_starting_date","job_status","success","los"],"properties":{"total_size":{"type":"integer","description":"Total size (in KB) for all downloadable LO (if they are downloadable)"},"job_id":{"type":"string","description":"Hash ID of the job in current download process is in progress. Null if job is completed"},"job_starting_date":{"type":"string","description":"Starting date of the job download process. Null if job is completed"},"job_status":{"description":"Status of the job","enum":["in_progress","completed","failed"],"type":"string"},"success":{"type":"boolean","description":"Status of the job process"},"message":{"type":"string","description":"Message if job fails"},"los":{"type":"array","description":"Array of course LO","items":{"$ref":"#/definitions/LearnLoDownloadLos"}}}},"LearnLoDownloadLos":{"required":["id","type"],"properties":{"id":{"type":"string","description":"Learning Object ID. Could be combination of lo ID and chapter ID in case of SCORM"},"type":{"type":"string","description":"The internal type of the learning object"},"resource_id":{"type":"string","description":"The physical resource ID related to the learning object"},"size":{"type":"integer","description":"Size of the training material in KB in case if could be downloadable"},"path":{"type":"string","description":"Download URL of training material"},"mobile_unsupported":{"type":"boolean","description":"Flag if the LO (SCORM currently only) is not supported by mobile devices"},"metadata":{"$ref":"#/definitions/LearnLoDownloadMetadata","description":"Additional metadata to the learning object"},"tracking":{"$ref":"#/definitions/LearnLoDownloadTracking","description":"Tracking information about the learning object for the current user"}}},"LearnLoDownloadMetadata":{"properties":{"presentation_order":{"type":"array","description":"Array of strings contains the name of the slide files ordered by presentation","items":{"type":"string"}},"seek_mode":{"type":"integer","description":"Video seek mode: 0 - disabled; 1 - enabled; 2 - enabled after completing the video"},"prerequisites":{"type":"array","description":"Contains array of strings of all learning object IDs to unblock the current LO","items":{"type":"integer"}},"scorm_version":{"type":"string","description":"Scorm version (in case of SCORM LO)"},"external":{"$ref":"#/definitions/LearnLoDownloadExternal","description":"External link for TinCan LO and its confabulated to be mobile_use_external_link"},"scorm_items":{"$ref":"#/definitions/LearnLoDownloadScormItems","description":"Scorm items (in case of SCORM LO)"}}},"LearnLoDownloadExternal":{"properties":{"deeplink_play":{"type":"string","description":"URL to play LO"},"deeplink_download":{"type":"string","description":"URL to download LO"}}},"LearnLoDownloadScormItems":{"required":["sco_id","launch_url","requirements","mastery_score"],"properties":{"sco_id":{"type":"string","description":"ID of the SCORM item"},"launch_url":{"type":"string","description":"URL to launch SCORM"},"requirements":{"type":"array","description":"SCORM item requirements","items":{"type":"string"}},"mastery_score":{"type":"integer","description":"SCORM mastery score (in case SCORM is in progress)"}}},"LearnLoDownloadTracking":{"properties":{"bookmark":{"type":"integer","description":"Current bookmark, in case of video or authoring learning object"},"scorm_items":{"$ref":"#/definitions/LearnLoDownloadScormItemsL2","description":"Scorm items tracking information"}}},"LearnLoDownloadScormItemsL2":{"required":["sco_id","cmi"],"properties":{"sco_id":{"type":"string","description":"ID of the SCORM item"},"cmi":{"$ref":"#/definitions/LearnLoDownloadCmi","description":"SCORM CMI instructions"}}},"LearnLoDownloadCmi":{},"LearnLoDownloadLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLoDownloadSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLoDownloadGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLoDownloadFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLoDownloadLast","description":"Link to the last page"}}},"LearnLoDownloadSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLoDownloadGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLoDownloadFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLoDownloadLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoUpdateScreenrecordingSchema":{"type":"object","required":["filename"],"properties":{"filename":{"type":"string","description":"Uploaded video filename"},"title":{"type":"string","description":"Title to assign to the learning object"},"description":{"type":"string","description":"Description to assign to the learning object"}}},"LearnLoUpdateScreenrecordingResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Success status","items":{"$ref":"#/definitions/LearnLoUpdateScreenrecordingData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoUpdateScreenrecordingLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoUpdateScreenrecordingData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"}}},"LearnLoUpdateScreenrecordingLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLoUpdateScreenrecordingSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLoUpdateScreenrecordingGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLoUpdateScreenrecordingFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLoUpdateScreenrecordingLast","description":"Link to the last page"}}},"LearnLoUpdateScreenrecordingSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLoUpdateScreenrecordingGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLoUpdateScreenrecordingFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLoUpdateScreenrecordingLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoCreateScreenrecordingPresignedUrlSchema":{"type":"object","required":["filename"],"properties":{"filename":{"type":"string","description":"Screencast file name"},"title":{"type":"string","description":"Screencast title"},"description":{"type":"string","description":"Screencast description"},"original_video_id":{"type":"integer","description":"Screencast video ID"}}},"LearnLoCreateScreenrecordingPresignedUrlResponse":{"required":["output","version"],"properties":{"output":{"type":"string","description":"Html output"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLoScormInteractionResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLoScormInteractionData","description":"Object that holds all interactions"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLoScormInteractionLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLoScormInteractionData":{"required":["interactions"],"properties":{"interactions":{"type":"array","description":"Array of questions and user answers for every SCO interaction","items":{"$ref":"#/definitions/LearnLoScormInteractionInteractions"}}}},"LearnLoScormInteractionInteractions":{"required":["type","id","timestamp","correct_responses","learner_response","result"],"properties":{"type":{"type":"string","description":"The type of interaction (e.g. 'true-false', 'choice', 'fill-in', 'long-fill-in', 'matching', 'numeric')"},"id":{"type":"string","description":"Question ID (e.g. Question4_1)"},"timestamp":{"type":"string","description":"Time at which the interaction was first made available to the learner for interaction and response (e.g. 15:49:13)"},"correct_responses":{"type":"array","description":"Array of correct responses","items":{"type":"string"}},"weighting":{"type":"integer","description":"Weight given to the interaction relative to other interactions"},"learner_response":{"type":"array","description":"Array of responses given by the user for the current question","items":{"type":"string"}},"result":{"type":"string","description":"Judgment of the correctness of the learner response (e.g. wrong)"},"latency":{"type":"string","description":"The value of this field is based on the Scorm Version for Scorm 1.2 is the time from the presentation of the stimulus to the completion of the measurable response (with format HHHH:MM:SS:SS), for Scorm 2004 is the time elapsed between the time the interaction was made available to the learner for response and the time of the first response (with format P[yY][mM][dD][T[hH][nM][s[.s]S]])."}}},"LearnLoScormInteractionLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLoScormInteractionSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLoScormInteractionGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLoScormInteractionFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLoScormInteractionLast","description":"Link to the last page"}}},"LearnLoScormInteractionSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLoScormInteractionGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLoScormInteractionFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLoScormInteractionLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLoImporterFieldsResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnLoImporterFieldsData","description":"Response success or failure to find fields"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLoImporterFieldsData":{"properties":{"fields":{"type":"array","description":"Associative array containing column names and translations","items":{"$ref":"#/definitions/LearnLoImporterFieldsFields"}}}},"LearnLoImporterFieldsFields":{},"LearnLoBatchAssignmentEvaluationSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Associative array containing key/value pairs to be imported","items":{"$ref":"#/definitions/LearnLoBatchAssignmentEvaluationItems"}}}},"LearnLoBatchAssignmentEvaluationItems":{"properties":{"submission_id":{"type":"integer","description":"ID of the assignment submission created by the learner. If no value is passed,"},"user_id":{"type":"integer","description":"ID of the learner submitting the assignment for which the evaluation is being sent"},"score":{"type":"integer","description":"Score given by the instructor. Default = “0”. Allowed range 0 - 100"},"comment":{"type":"string","description":"Evaluation comments written by the instructor"},"instructor_id":{"type":"integer","description":"ID of the instructor that evaluated this assignment"},"allow_reupload":{"type":"boolean","description":"Whether the learner is allowed to submit again for this training material when failed. Default = true"},"status":{"description":"Evaluation status. Possible values: “failed”, “passed”","enum":["failed","passed"],"type":"string"},"url":{"type":"string","description":"Hashed filename of instructor’s evaluation report"},"filename":{"type":"string","description":"Original file name as when uploaded by the instructor"}},"required":["user_id","instructor_id","status"]},"LearnLoBatchAssignmentEvaluationResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Response Data","items":{"$ref":"#/definitions/LearnLoBatchAssignmentEvaluationData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLoBatchAssignmentEvaluationData":{"properties":{"item":{"$ref":"#/definitions/LearnLoBatchAssignmentEvaluationItem","description":"Single record (item)"}}},"LearnLoBatchAssignmentEvaluationItem":{"properties":{"success":{"type":"boolean","description":"Status of the operation"},"error_message":{"type":"string","description":"if success = false, then this field contains the raised error message"},"output":{"$ref":"#/definitions/LearnLoBatchAssignmentEvaluationOutput","description":""}}},"LearnLoBatchAssignmentEvaluationOutput":{"required":["user_id","submission_id"],"properties":{"user_id":{"type":"integer","description":"ID of the learner submitting the assignment"},"submission_id":{"type":"integer","description":"ID of the assignment submission created by this API"}}},"LearnLocationIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLocationIndexData","description":"List of all retrieved subscription schemas"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLocationIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLocationIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of locations","items":{"$ref":"#/definitions/LearnLocationIndexItems"}},"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/LearnLocationIndexSort"}}}},"LearnLocationIndexItems":{"required":["id","name","country"],"properties":{"id":{"type":"integer","description":"Location ID"},"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Location address"},"country":{"type":"string","description":"Location country"},"telephone":{"type":"string","description":"Location telephone"},"email":{"type":"string","description":"Location email"},"directions":{"type":"string","description":"Location directions"},"accommodations":{"type":"string","description":"Location suggested accommodations"},"other_info":{"type":"string","description":"Location other_info"},"images":{"type":"array","description":"Location images","items":{"type":"string"}}}},"LearnLocationIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnLocationIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLocationIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLocationIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLocationIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLocationIndexLast","description":"Link to the last page"}}},"LearnLocationIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLocationIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLocationIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLocationIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLocationLocationResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLocationLocationData","description":"Information about the location"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLocationLocationLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLocationLocationData":{"required":["id","name","country"],"properties":{"id":{"type":"integer","description":"Location ID"},"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Location address"},"country":{"type":"string","description":"Location country"},"telephone":{"type":"string","description":"Location telephone"},"email":{"type":"string","description":"Location email"},"directions":{"type":"string","description":"Location directions"},"accommodations":{"type":"string","description":"Location suggested accommodations"},"other_info":{"type":"string","description":"Location other_info"},"images":{"type":"array","description":"Location images","items":{"type":"string"}}}},"LearnLocationLocationLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLocationLocationSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLocationLocationGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLocationLocationFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLocationLocationLast","description":"Link to the last page"}}},"LearnLocationLocationSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLocationLocationGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLocationLocationFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLocationLocationLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLocationLocationClassroomResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLocationLocationClassroomData","description":"Information about the classroom"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLocationLocationClassroomLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLocationLocationClassroomData":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"The ID of the classroom"},"name":{"type":"string","description":"Classroom name"},"details":{"type":"string","description":"Classroom details"},"seats":{"type":"integer","description":"Classroom number of seats"},"equipment":{"type":"string","description":"Classroom equipment"}}},"LearnLocationLocationClassroomLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLocationLocationClassroomSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLocationLocationClassroomGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLocationLocationClassroomFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLocationLocationClassroomLast","description":"Link to the last page"}}},"LearnLocationLocationClassroomSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLocationLocationClassroomGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLocationLocationClassroomFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLocationLocationClassroomLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLocationLocationClassroomIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLocationLocationClassroomIndexData","description":"Response success or failure to find classrooms"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLocationLocationClassroomIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLocationLocationClassroomIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"list of classrooms for the given location id","items":{"$ref":"#/definitions/LearnLocationLocationClassroomIndexItems"}},"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/LearnLocationLocationClassroomIndexSort"}}}},"LearnLocationLocationClassroomIndexItems":{"required":["id","name"],"properties":{"id":{"type":"integer","description":"The ID of the classroom"},"name":{"type":"string","description":"Classroom name"},"details":{"type":"string","description":"Classroom details"},"seats":{"type":"integer","description":"Classroom number of seats"},"equipment":{"type":"string","description":"Classroom equipment"}}},"LearnLocationLocationClassroomIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnLocationLocationClassroomIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLocationLocationClassroomIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLocationLocationClassroomIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLocationLocationClassroomIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLocationLocationClassroomIndexLast","description":"Link to the last page"}}},"LearnLocationLocationClassroomIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLocationLocationClassroomIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLocationLocationClassroomIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLocationLocationClassroomIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLocationCreateSchema":{"type":"object","required":["name","country"],"properties":{"name":{"type":"string","description":"the name of the location"},"address":{"type":"string","description":"street address for the location"},"country":{"type":"string","description":"unique name of the country for the location (e.g. Bulgaria, Italy)"},"telephone":{"type":"string","description":"the telephone number for the location"},"email":{"type":"string","description":"email contact for the location"},"reaching_info":{"type":"string","description":"Directions to reach/find the location"},"accomodations":{"type":"string","description":"Accommodation information for people attending the course in the location"},"other_info":{"type":"string","description":"Additional details about the location"}}},"LearnLocationCreateResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/LearnLocationCreateData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLocationCreateData":{"required":["success","location_id"],"properties":{"success":{"type":"boolean","description":"Success or failure for updating location"},"location_id":{"type":"integer","description":"The internal ID for the newly created location"}}},"LearnLocationUpdateSchema":{"type":"object","properties":{"name":{"type":"string","description":"the name of the location"},"address":{"type":"string","description":"street address for the location"},"country":{"type":"string","description":"unique name of the country for the location (e.g. Bulgaria, Italy)"},"telephone":{"type":"string","description":"the telephone number for the location"},"email":{"type":"string","description":"email contact for the location"},"reaching_info":{"type":"string","description":"Directions to reach/find the location"},"accomodations":{"type":"string","description":"Accommodation information for people attending the course in the location"},"other_info":{"type":"string","description":"Additional details about the location"}}},"LearnLocationUpdateResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/LearnLocationUpdateData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLocationUpdateData":{"required":["success","location_id"],"properties":{"success":{"type":"boolean","description":"Success or failure for updating location"},"location_id":{"type":"integer","description":"The internal ID for the updated location"}}},"LearnLocationDeleteResponse":{"required":["data","version"],"properties":{"data":{"type":"array","description":"Success or failure","items":{"$ref":"#/definitions/LearnLocationDeleteData"}},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLocationDeleteData":{"required":["success","location_id"],"properties":{"success":{"type":"boolean","description":"Success or failure for updating location"},"location_id":{"type":"integer","description":"The internal ID for the deleted location"}}},"LearnLpCreateSchema":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string","description":"The name of the Learning plan"},"description":{"type":"string","description":"The description of the Learning plan"},"code":{"type":"string","description":"The code of the Learning plan"}}},"LearnLpCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpCreateData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLpCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLpCreateData":{"required":["id_lp"],"properties":{"id_lp":{"type":"integer","description":"the internal id of newly created LP"}}},"LearnLpCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLpCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLpCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLpCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLpCreateLast","description":"Link to the last page"}}},"LearnLpCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLpCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLpCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLpCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLpDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpDeleteData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources.","items":{"$ref":"#/definitions/LearnLpDeleteLinks"}}}},"LearnLpDeleteData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnLpDeleteLinks":{},"LearnLpIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpIndexData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLpIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLpIndexData":{"required":["items"],"properties":{"items":{"type":"array","description":"List of Learning plans","items":{"$ref":"#/definitions/LearnLpIndexItems"}}}},"LearnLpIndexItems":{"required":["id","code","name","create_date","image","type","date_last_updated","count","has_more_data","current_page","current_page_size"],"properties":{"id":{"type":"string","description":"The numeric id of the LP"},"code":{"type":"string","description":"The code of the current LP (can be empty string) if there is no code for the current LP"},"name":{"type":"string","description":"The name of the current LP to be displayed in the header part"},"description":{"type":"string","description":"The HTML description text of the LP to be displayed."},"create_date":{"type":"string","format":"date","description":"The date when the learning plan have been created"},"image":{"type":"string","description":"The numeric image id of the LP"},"type":{"type":"integer","description":"The type of the learning plan context (1 = Learning Plan, 2 = Certification) Present only when New Certification feature is enabled"},"date_last_updated":{"type":"string","format":"date","description":"The date and time of the last update action on the learning plan. Format is "yyyy-MM-dd HH:mm:ss", UTC timezone"},"courses":{"type":"array","description":"An array containing course object that are in this learning plan","items":{"$ref":"#/definitions/LearnLpIndexCourses"}},"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/LearnLpIndexSort"}}}},"LearnLpIndexCourses":{"required":["id_course","name","description","course_type"],"properties":{"id_course":{"type":"string","description":"Unique numeric ID of the learning plan"},"name":{"type":"string","description":"Name of the learning plan"},"description":{"type":"string","description":"Description of the learning plan"},"course_type":{"description":"Type of the course","enum":["elearning","classroom"],"type":"string"}}},"LearnLpIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnLpIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLpIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLpIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLpIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLpIndexLast","description":"Link to the last page"}}},"LearnLpIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLpIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLpIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLpIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLpUpdateSchema":{"type":"object","required":["name","description"],"properties":{"name":{"type":"string","description":"Name of the Learning plan"},"description":{"type":"string","description":"Description of the Learning plan"},"code":{"type":"string","description":"Code of the Learning plan"},"catalog_show_alternative_learning_plans":{"type":"boolean","description":"Show alternative LPs about this course"},"catalog_show_alternative_subscription_plans":{"type":"boolean","description":"Show alternative subscriptions plans about this course"},"catalog_show_buy_now":{"type":"boolean","description":"Show buy now button on this course"},"ecommerce_pricing_system_default":{"type":"integer","description":"The ecommerce default pricing system id"},"soft_deadline":{"type":"boolean","description":"Whether to enable the soft deadline for the specified learning plan."}}},"LearnLpUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpUpdateData","description":"Response data"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"type":"array","description":"Links to related resources.","items":{"$ref":"#/definitions/LearnLpUpdateLinks"}}}},"LearnLpUpdateData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnLpUpdateLinks":{},"LearnLpViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpViewData","description":"Data for the learning plan"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLpViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLpViewData":{"required":["id","uuid","code","name","description","short_description","create_date","status","complete_percent","curricula_redirect_to_learning_plan","type","credits","player_appearance","focus_mode","harmony_tutoring","settings","deeplink","ecommerce","enrollment","subscription","courses","language","lang_label","enter_status","slug_name","is_assigned","meta_description"],"properties":{"id":{"type":"integer","description":"Unique ID of the learning plan"},"uuid":{"type":"string","description":"UUID of the learning plan"},"code":{"type":"string","description":"Code of the learning plan"},"name":{"type":"string","description":"Name of the learning plan"},"description":{"type":"string","description":"Description of the learning plan"},"short_description":{"type":"string","description":"Short description of the learning plan"},"create_date":{"type":"string","description":"The date when the learning plan was created"},"image":{"type":"string","description":"URL to access the thumbnail image of the learning plan"},"cover_url":{"type":"string","description":"URL to cover image of the learning plan. Only returned if a cover image is set"},"total_duration":{"type":"integer","description":"The calculated total duration of the learning plan that is the result of the sum of all course duration times for all courses in the learning plan"},"status":{"type":"enum(not_subscribed,subscribed,'waiting',in_progress,completed)","description":"Status of the user in the learning plan"},"mandatory_courses_completed_at_completion":{"type":"integer","description":"Number of mandatory courses completed by the user at the time of completion (Can be NULL. Available only if the Learning Plan Enrollment Persisting Status feature is active)"},"mandatory_courses_total_at_completion":{"type":"integer","description":"Total number of mandatory courses in the learning plan at the time of completion (Can be NULL. Available only if the Learning Plan Enrollment Persisting Status feature is active)"},"complete_percent":{"type":"integer","description":"The percentage of the current LP completed by the user"},"last_played_course":{"type":"integer","description":"The last played course by the current user"},"curricula_redirect_to_learning_plan":{"type":"boolean","description":"Redirect back to LP when user complete course in LP"},"is_certification":{"type":"boolean","description":"Whether the learning plan is of type certification. Only returned if the new certifications feature is enabled"},"type":{"type":"string","description":"Type of learning plan, in this case always type will be learning plan"},"credits":{"type":"number","format":"float","description":"Number of credits that can be earned with completion of the Learning Plan"},"header_layout":{"$ref":"#/definitions/LearnLpViewHeaderLayout","description":"Header Layout settings for new Learning Plan page. Only returned if a custom header layout is specified for the learning plan"},"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 active"},"harmony_tutoring":{"type":"boolean","description":"Whether the Harmony Tutoring is active"},"settings":{"$ref":"#/definitions/LearnLpViewSettings","description":"Object with the settings of the learning plan"},"deeplink":{"type":"string","description":"Only available if LP has deeplinking enabled"},"ecommerce":{"$ref":"#/definitions/LearnLpViewEcommerceL3","description":"The ecommerce pricing system"},"enrollment":{"$ref":"#/definitions/LearnLpViewEnrollment","description":"Object that contains information about the enrollment of the learning plan"},"subscription":{"$ref":"#/definitions/LearnLpViewSubscription","description":"Subscription information"},"courses":{"type":"array","description":"An array containing course object that are in this learning plan","items":{"$ref":"#/definitions/LearnLpViewCourses"}},"language":{"$ref":"#/definitions/LearnLpViewLanguage","description":"The language of the learning plan. This value can be null."},"lang_label":{"type":"string","description":"The language label of the learning plan, e.g. "English". It can be null"},"enter_status":{"$ref":"#/definitions/LearnLpViewEnterStatus","description":"Object containing information about the entering policy of the learning plan"},"slug_name":{"type":"string","description":"The Slug name (name-with-dashes) of this Learning Plan"},"redirect_to":{"type":"string","description":"Redirect the user to this url when visit the learning plan page. Only when SEO App is active."},"is_assigned":{"type":"boolean","description":"Whether the LP is assigned to the currently logged user"},"certificate_url":{"type":"string","description":"The downloadable certificate url"},"certificate_name":{"type":"string","description":"The name of the certificate associated with the learning plan. Only returned if a certificate is configured for the learning plan"},"catalog_show_alternative_learning_plans":{"type":"boolean","description":"Show alternative LPs about this course"},"catalog_show_alternative_subscription_plans":{"type":"boolean","description":"Show alternative subscriptions plans about this course"},"catalog_show_buy_now":{"type":"boolean","description":"Show buy now button on this course"},"ecommerce_pricing_system_default":{"type":"integer","description":"The ecommerce default pricing system id"},"meta_description":{"type":"string","description":"Seo meta description content. Can be null"},"certification":{"$ref":"#/definitions/LearnLpViewCertification","description":"Certification related to the learning plan"},"certification_award":{"$ref":"#/definitions/LearnLpViewCertificationAward","description":"Active certification award for the certification related to this learning plan"},"award":{"$ref":"#/definitions/LearnLpViewAward","description":"Award object for certification learning plans (returned only if feature is enabled and the LP is the Certificatuon kind, and the user has an award)."}}},"LearnLpViewHeaderLayout":{"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 a color is set"}}},"LearnLpViewSettings":{"required":["show_in_catalog","enable_catchup","days_of_validity"],"properties":{"show_in_catalog":{"type":"boolean","description":"Whether or not to show the learning plan in the catalog"},"enable_catchup":{"type":"boolean","description":"Whether or not the learning plan has the "Ctahcup courses" functionality enabled"},"days_of_validity":{"type":"integer","description":"The number of days the learning plan is valid"},"days_valid_mode":{"description":"Whether the days of validity are calculated from the first access or from when the enrollment is created. Only returned if days of validity is set","enum":["first_access","enrollment_creation"],"type":"string"}}},"LearnLpViewEcommerce":{"required":["on_sale","price","purchase_method"],"properties":{"on_sale":{"type":"boolean","description":"Whether or not the learning plan is on sale"},"price":{"type":"integer","description":"The price of the learning plan"},"purchase_method":{"type":"integer","description":"Identifying number of the payment method"}}},"LearnLpViewEnrollment":{"properties":{"date_end":{"type":"string","format":"date","description":"The date and time in format "yyyy-mm-dd HH:mm:ss" (UTC) at which the user will not be able to access the learning plan anymore. Only returned if days of validity are set for the learning plan"},"assignment_type":{"type":"string","description":"Enrollment assignment type for the user. This field is returned only when this enrollment attribute is configured in the platform advanced settings."}},"required":["assignment_type"]},"LearnLpViewSubscription":{"properties":{"selection_status":{"type":"integer","description":"Whether or not the subscription includes the children of the object of the subscription"},"name":{"type":"string","description":"Subscription bundle name"},"start_date":{"type":"string","description":"Starting date of the subscription"},"end_date":{"type":"string","description":"Ending date of the subscription"},"record_id":{"type":"integer","description":"Record ID of the subscription"},"availability":{"type":"integer","description":"Availability of the subscription"},"users_associated":{"type":"integer","description":"A count of the users associated with the subscription"},"enrollments_done":{"type":"integer","description":"A count of the enrollments in this subscription"},"type":{"type":"integer","description":"Type of the subscription"},"status":{"type":"integer","description":"Whether or not the subscription is active"},"object_type":{"type":"integer","description":"Type of the object of the subscription"},"object_id":{"type":"integer","description":"Unique ID of the object of the subscription"},"price":{"type":"string","description":"Price of the subscription. Could be integer ot "free""}},"required":["name"]},"LearnLpViewCourses":{"required":["idCourse","code","name","description","short_description","course_type","img_course","provider","duration","time_spent","slug_name","image","status","is_self_enrollment_available","all_lessons","all_sessions","competed_lessons","can_enter","can_enter_reason","skills","is_required","is_published"],"properties":{"idCourse":{"type":"integer","description":"Unique ID of the course"},"code":{"type":"string","description":"Code of the course"},"name":{"type":"string","description":"Name of the course"},"description":{"type":"string","description":"Description of the course"},"short_description":{"type":"string","description":"Description of the course, stripped of any HTML tags."},"course_type":{"description":"Course type","enum":["elearning","classroom"],"type":"string"},"power_user_total_seats":{"type":"integer","description":"The total count of seats (purchased + extra) owned by the current user. Only returned if the user is a PU and can buy seats and is assigned to the course"},"power_user_available_seats":{"type":"integer","description":"The count of seats still available for the current user. Only returned if the user is a PU and can buy seats and is assigned to the course"},"img_course":{"type":"integer","description":"Unique ID of the asset that is used for the course thumbnail"},"provider":{"type":"integer","description":"Provider of the course. 0 = Internal Course"},"duration":{"type":"integer","description":"Duration of the course in minutes"},"time_spent":{"type":"integer","description":"Time the user spent on this course"},"slug_name":{"type":"string","description":"The Slug name (name-with-dashes) of the course"},"image":{"type":"string","description":"URL to access the thumbnail image of the course"},"status":{"description":"Status of the user in this course","enum":["locked","not_started","enrolled","in_progress","completed"],"type":"string"},"date_subscribed":{"type":"string","description":"The date when the user has been enrolled into the course"},"date_completed":{"type":"string","description":"The date when the user completed the course, if not completed the value is null"},"course_date_start":{"type":"string","format":"date","description":"The date in format "yyyy-mm-dd" from which the user can access the course. Only returned when the date is set for the course"},"course_date_end":{"type":"string","format":"date","description":"The date in format "yyyy-mm-dd" by which the user can access the course. Only returned when the date is set for the course"},"is_soft_deadline_enabled":{"type":"boolean","description":"Whether the soft deadline is enabled for this course. Only returned if the platform default setting was overridden in this course"},"is_self_enrollment_available":{"type":"boolean","description":"Whether the user can self-enroll in (or buy) the course"},"all_lessons":{"type":"integer","description":"All learning objects in course"},"all_sessions":{"type":"integer","description":"All sessions in course"},"competed_lessons":{"type":"integer","description":"The user's completed learning objects"},"price":{"type":"number","format":"float","description":"The price of the course"},"ecommerce":{"$ref":"#/definitions/LearnLpViewEcommerceL2","description":"Ecommerce data for the course"},"lang_code":{"type":"string","description":"The language of the course"},"available_seats":{"$ref":"#/definitions/LearnLpViewAvailableSeats","description":"Available seats for the course, if course have session, data is split by session id. If not available, the default value is null"},"available_seats_course":{"type":"integer","description":"Available seats for the course. Only returned if the course has a maximum enrollment quota set"},"maximum_enrollment_quota":{"type":"integer","description":"Maximum enrollment quota for the course. Only returned if it is set in the course"},"allow_overbooking":{"type":"integer","description":"Flag, which points, if the course overbooking is allowed or not. Possible values 1 and 0"},"can_enter":{"type":"boolean","description":"Returns true or false based on that if the user can_enter in the current course or not, this property is available only when the user is logged in."},"can_enter_reason":{"type":"string","description":"Returns the reason, if the user can not enter the course"},"can_enter_reason_code":{"type":"string","description":"The unique code of the reason why the user cannot enter the course. Only returned if the user cannot access the course"},"unlocking_datetime":{"type":"string","format":"date","description":"The datetime when the course is unlocked for a user (in format yyyy-MM-dd HH:mm::ss, UTC timezone)"},"is_affiliate":{"type":"boolean","description":"Has content partner"},"partner_fields":{"type":"string","description":"Content Partner fields"},"partner_data":{"$ref":"#/definitions/LearnLpViewPartnerData","description":"Content Partner data"},"affiliate_price":{"type":"string","description":"Affiliate price"},"is_enrolled":{"type":"integer","description":"User is enrolled to the course"},"instructors":{"type":"array","description":"(New ILT only) Array containing the instructor list for this session. Only returned if get_courses_instructors=1","items":{"$ref":"#/definitions/LearnLpViewInstructors"}},"skills":{"type":"array","description":"Array of skills associated with the course","items":{"$ref":"#/definitions/LearnLpViewSkills"}},"is_required":{"type":"boolean","description":"Returns TRUE if the course is required, if is optional it returns FALSE"},"is_published":{"type":"boolean","description":"Returns TRUE if the course is published in the course management"}}},"LearnLpViewEcommerceL2":{"properties":{"prices":{"$ref":"#/definitions/LearnLpViewPrices","description":"The object that contains the course prices"}}},"LearnLpViewPrices":{"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."}}},"LearnLpViewAvailableSeats":{"required":["id"],"properties":{"id":{"type":"integer","description":"id is the id of the session; the value is the available seats for that session"}}},"LearnLpViewPartnerData":{"required":["id","referral_id","name","description","logo","city","country","state","address","phone","email","website","discount","affiliate_code","enable_affiliate","catalog_visible","course_visible","active","updated_at","updated_by"],"properties":{"id":{"type":"integer","description":"ID of the content partner resource"},"referral_id":{"type":"string","description":"The referral code"},"name":{"type":"string","description":"Json encoded object with type, value and values keys"},"description":{"type":"string","description":"Json encoded object with type, value and values keys"},"logo":{"type":"string","description":"Name of the logo resource - WILL BE DEPRECATED ON 2019-01-19"},"city":{"type":"string","description":"The name of the city - can be empty"},"country":{"type":"string","description":"The name of the country - can be empty"},"state":{"type":"string","description":"The name of the state - can be empty"},"address":{"type":"string","description":"The address - can be empty"},"phone":{"type":"string","description":"The phone - can be empty"},"email":{"type":"string","description":"The email - can be empty"},"website":{"type":"string","description":"The website - can be empty"},"discount":{"type":"string","description":"The discount - can be empty"},"affiliate_code":{"type":"string","description":"The affiliate_code - can be empty"},"enable_affiliate":{"type":"string","description":"Flag to know if the affiliate is enabled"},"catalog_visible":{"type":"string","description":"Flag to know if the catalog is visible"},"course_visible":{"type":"string","description":"Flag to know if the course is visible"},"active":{"type":"string","description":"Flag to know if the course is active"},"updated_at":{"type":"string","description":"The last update date"},"updated_by":{"type":"string","description":"The ID of the user that last updated the resource"},"logo_full_path":{"type":"string","description":"The full path of the logo"}}},"LearnLpViewInstructors":{"required":["firstname","lastname","username"],"properties":{"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"}}},"LearnLpViewSkills":{"required":["title"],"properties":{"title":{"type":"string","description":"Title of the skill in the selected language"}}},"LearnLpViewLanguage":{"properties":{"code":{"type":"string","description":"Code of the learning plan language"},"name":{"type":"string","description":"Name of the learning plan language"},"browser_code":{"type":"string","description":"Browser code (2 characters) of the learning plan language"}}},"LearnLpViewEnterStatus":{"required":["status","price"],"properties":{"status":{"description":"The status of the entering policy of the learning plan","enum":["play","enroll","buy"],"type":"string"},"price":{"type":"integer","description":"Price of the learning plan"},"seats":{"type":"integer","description":"If the learning plan can be bought one seat at a time, this indicates the number of seats"}}},"LearnLpViewEcommerceL3":{"properties":{"sold_individually":{"type":"boolean","description":"Whether the content can be sold individually or not"},"price":{"type":"string","description":"The price from the external pricing system"},"discounted_price":{"type":"string","description":"The discounted price from the external pricing system"},"currency":{"type":"string","description":"The currency from the external pricing system"},"currency_symbol":{"type":"string","description":"The currency symbol from the external pricing system"},"currency_extended_name":{"type":"string","description":"The currency from the external pricing system"},"alternative_purchase_options":{"$ref":"#/definitions/LearnLpViewAlternativePurchaseOptions","description":""},"prices":{"$ref":"#/definitions/LearnLpViewPricesL2","description":"The object that contains the learning plan prices"}},"required":["price","currency","currency_symbol","currency_extended_name"]},"LearnLpViewAlternativePurchaseOptions":{"properties":{"subscription_plans_resume_page_url":{"type":"string","description":"The redirect url as alternative purchase"}}},"LearnLpViewPricesL2":{"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."}}},"LearnLpViewCertification":{"required":["id","code","name"],"properties":{"id":{"type":"integer","description":"The certification's ID"},"code":{"type":"string","description":"The certification's code"},"name":{"type":"string","description":"The certification's name"}}},"LearnLpViewCertificationAward":{"required":["id","issued_at","expiring_at","renewal","renewal_options"],"properties":{"id":{"type":"integer","description":"The awarded certification's ID"},"issued_at":{"type":"string","description":"The awarded certification's issue date"},"expiring_at":{"type":"string","description":"The awarded certification's expiring date (null if it never expires)"},"renewal":{"$ref":"#/definitions/LearnLpViewRenewal","description":"Certification renewal state"},"renewal_options":{"$ref":"#/definitions/LearnLpViewRenewalOptions","description":"Certification renewability state"}}},"LearnLpViewRenewal":{"required":["started","started_at"],"properties":{"started":{"type":"boolean","description":"A flag that inform if the certification renewal is started"},"started_at":{"type":"string","description":"datetime of the renewal start (if renewal is started multiple times, it tracks the first start)"}}},"LearnLpViewRenewalOptions":{"required":["this_resource","other_resources"],"properties":{"this_resource":{"type":"boolean","description":"if the certification can be renewed by this learning plan"},"other_resources":{"type":"boolean","description":"if the certification can be renewed by other resources than this learning plan"}}},"LearnLpViewAward":{"properties":{"expiration_date":{"type":"string","format":"date","description":"Expiration datetime of the award. Can be null when it never expires, in format "yyyy-mm-dd HH:mm:ss" (UTC)."},"award_date":{"type":"string","format":"date","description":"Award assignment datetime, in format "yyyy-mm-dd HH:mm:ss" (UTC)."},"in_renew":{"type":"boolean","description":"Whether the award is currently in renewal state."},"renew_date":{"type":"string","format":"date","description":"Datetime when the renewal was started (if any), in format "yyyy-mm-dd HH:mm:ss" (UTC)."},"renewal_window_date_start":{"type":"string","format":"date","description":"Start datetime of the renewal window, in format "yyyy-mm-dd HH:mm:ss" (UTC)."},"renewal_window_date_end":{"type":"string","format":"date","description":"End datetime of the renewal window, in format "yyyy-mm-dd HH:mm:ss" (UTC)."},"renewal_mode":{"description":"Renewal mode as configured on the certification (null when no expiration).","enum":["anytime","window","null"],"type":"string"},"status":{"description":"Status of the award.","enum":["valid","expired","expiring"],"type":"string"}},"required":["award_date","in_renew","status"]},"LearnLpViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLpViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLpViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLpViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLpViewLast","description":"Link to the last page"}}},"LearnLpViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLpViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLpViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLpViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLpEnrollSchema":{"type":"object","required":["id_lp","id_user"],"properties":{"id_lp":{"type":"integer","description":"ID of the Learning plan"},"id_user":{"type":"integer","description":"ID of the LMS user"},"status":{"description":"Enrollment status. Available only if the Learning Plan Enrollment Persisting Status feature is active","enum":["subscribed","in_progress","completed"],"type":"string"}}},"LearnLpEnrollResponse":{"required":["data","version","enrolled","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpEnrollData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"enrolled":{"type":"array","description":"Result of the enrollment (success, failure)","items":{"$ref":"#/definitions/LearnLpEnrollEnrolled"}},"_links":{"$ref":"#/definitions/LearnLpEnrollLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLpEnrollData":{},"LearnLpEnrollEnrolled":{"required":["id_path","id_user","waiting"],"properties":{"id_path":{"type":"integer","description":"The id of the learning plan the user has been enrolled into"},"id_user":{"type":"integer","description":"The id of the user enrolled in the learning plan"},"waiting":{"type":"boolean","description":"Flag for user status on learning plan, currently unused and set to false"}}},"LearnLpEnrollLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnLpEnrollSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnLpEnrollGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnLpEnrollFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnLpEnrollLast","description":"Link to the last page"}}},"LearnLpEnrollSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnLpEnrollGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnLpEnrollFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnLpEnrollLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnLpDeeplinkSchema":{"type":"object","required":["hash","generated_by"],"properties":{"hash":{"type":"string","description":"The hash generated by the user"},"generated_by":{"type":"integer","description":"The id of the user that generate the hash"}}},"LearnLpDeeplinkResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpDeeplinkData","description":"Success or failure to find Learning plan"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnLpDeeplinkLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnLpDeeplinkData":{"required":["message","operationCode","redirectUrl","success"],"properties":{"message":{"type":"string","description":"Message of the operation"},"operationCode":{"type":"integer","description":"The code of the operation"},"redirectUrl":{"type":"string","description":"URL, where user should be redirected after this API call"},"success":{"type":"boolean","description":"Status of the operation"}}},"LearnLpDeeplinkLinks":{},"LearnLpCreateLpDismissionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpCreateLpDismissionData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLpCreateLpDismissionData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"The status of the operation"}}},"LearnLpUndoLpDismissionResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnLpUndoLpDismissionData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnLpUndoLpDismissionData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"The status of the operation"}}},"LearnLpUnenrollSchema":{"type":"object","properties":{"use_secondary_identifier":{"type":"boolean","description":"Interpret ID param as secondary identifier (i.e. alphanumeric learningplan code). Default is false."}}},"LearnLpUnenrollResponse":{"required":["success","version"],"properties":{"success":{"type":"boolean","description":"The operation success status"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnSubscriptionbundleCreateSchema":{"type":"object","required":["name","description","type"],"properties":{"name":{"type":"string","description":"Subscription bundle name"},"description":{"type":"string","description":"Subscription bundle description"},"item_ids":{"type":"array","description":"Array of subscription bundle item IDs","items":{"type":"integer"}},"code":{"type":"string","description":"Subscription bundle code"},"published":{"type":"integer","description":"Subscription bundle published. Options 0 - not published, 1 - published. Default - 1"},"type":{"description":"Subscription bundle type. Seats - 2, Licences - 1","enum":["1","2"],"type":"integer"},"branches":{"$ref":"#/definitions/LearnSubscriptionbundleCreateBranches","description":"Array of subscription bundle visibilities"},"groups":{"type":"array","description":"Array of Group IDs to be added to visibilities","items":{"type":"integer"}},"additional_fields":{"$ref":"#/definitions/LearnSubscriptionbundleCreateAdditionalFields","description":"Array of field_id and value pairs to populate additional fields defined for the Bundle."},"propagate_to_transactions":{"type":"boolean","description":"If true every change in the bundle (add/delete catalog) will be propagated to the transactions (default false)."}}},"LearnSubscriptionbundleCreateBranches":{},"LearnSubscriptionbundleCreateAdditionalFields":{"properties":{"field_xxx":{"type":"string","description":"Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."}}},"LearnSubscriptionbundleCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleCreateData","description":"ID of new record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleCreateData":{"required":["created_bundle_id"],"properties":{"created_bundle_id":{"type":"integer","description":"The internal ID for the newly created subscription bundle"}}},"LearnSubscriptionbundleCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleCreateLast","description":"Link to the last page"}}},"LearnSubscriptionbundleCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleDeleteData":{"required":["error","deleted_bundle"],"properties":{"error":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteError","description":"Errors during process"},"deleted_bundle":{"type":"string","description":"ID of the successfully deleted item"}}},"LearnSubscriptionbundleDeleteError":{"required":["message","bundle_plans"],"properties":{"message":{"type":"string","description":"Process that generated an error"},"bundle_plans":{"type":"array","description":"Subscription bundle plans","items":{"type":"string"}}}},"LearnSubscriptionbundleDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteLast","description":"Link to the last page"}}},"LearnSubscriptionbundleDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleIndexData","description":"List of all retrieved subscription bundles"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of subscription bundles info objects","items":{"$ref":"#/definitions/LearnSubscriptionbundleIndexItems"}},"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/LearnSubscriptionbundleIndexSort"}}}},"LearnSubscriptionbundleIndexItems":{"required":["id","name","description","code","published","type","user_can_buy","sub_items","visibility","type_id","plans","actions"],"properties":{"id":{"type":"integer","description":"ID of the subscription bundle"},"name":{"type":"string","description":"Subscription bundle title"},"description":{"type":"string","description":"Subscription bundle description"},"code":{"type":"string","description":"Subscription bundle code"},"published":{"type":"boolean","description":"Subscription bundle published field"},"type":{"type":"string","description":"Subscription bundle type"},"user_can_buy":{"type":"boolean","description":"If the calling user can buy the bundle plans"},"sub_items":{"$ref":"#/definitions/LearnSubscriptionbundleIndexSubItems","description":"Array of subscription bundle items info objects"},"visibility":{"$ref":"#/definitions/LearnSubscriptionbundleIndexVisibility","description":"Array of subscription bundle visibility info objects"},"type_id":{"type":"integer","description":"Bundle type (1 - licenses, 2 - seat)"},"plans":{"type":"array","description":"Subscription bundle plans","items":{"$ref":"#/definitions/LearnSubscriptionbundleIndexPlans"}},"actions":{"type":"array","description":"Actions that current user can perform (e.g. "delete", "edit", etc.)","items":{"type":"string"}}}},"LearnSubscriptionbundleIndexSubItems":{"required":["item_id","name"],"properties":{"item_id":{"type":"string","description":"Subscription item ID"},"name":{"type":"string","description":"Subscription item name"}}},"LearnSubscriptionbundleIndexVisibility":{"required":["id","id_object","selection_status","type","type_label","title"],"properties":{"id":{"type":"integer","description":"Subscription visibility ID"},"id_object":{"type":"integer","description":"ID of the object (branch ID or group ID)"},"selection_status":{"type":"integer","description":"Object (it is meaningful only for Branches) selection status, options: 1 - A single branch is selected, 2 - A branch and all the descendants are selected"},"type":{"type":"integer","description":"Obect type. Options: 1 - branch, 2 - group"},"type_label":{"type":"string","description":"Obect type label, e.g. "branch""},"title":{"type":"string","description":"Title (branch or group)"}}},"LearnSubscriptionbundleIndexPlans":{"required":["id","plan_name","price","code","availability","renewal_type","validity_units","validity_period","enforce_limit"],"properties":{"id":{"type":"integer","description":"Subscription plan ID"},"plan_name":{"type":"string","description":"Subscription plan name"},"price":{"type":"number","format":"float","description":"Subscription plan price"},"code":{"type":"string","description":"Subscription plan code"},"availability":{"type":"integer","description":"Subscription plan availability"},"renewal_type":{"type":"integer","description":"Subscription plan renewal type"},"validity_units":{"type":"integer","description":"Subscription plan validity units"},"validity_period":{"type":"integer","description":"Subscription plan validity period"},"field_1111":{"type":"string","description":"Additional field value. In field_1111, "1111" is field ID. There are multiple additional fields created using this pattern"},"enforce_limit":{"type":"integer","description":"Subscription plan enforce limit"}}},"LearnSubscriptionbundleIndexSort":{"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"}}},"LearnSubscriptionbundleIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleIndexLast","description":"Link to the last page"}}},"LearnSubscriptionbundleIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleUpdateSchema":{"type":"object","properties":{"name":{"type":"string","description":"Subscription bundle name"},"description":{"type":"string","description":"Subscription bundle description"},"code":{"type":"string","description":"Subscription bundle code"},"item_ids":{"type":"array","description":"Array of subscription bundle item IDs","items":{"type":"integer"}},"published":{"type":"integer","description":"Subscription bundle published. Options 0 - not published, 1 - published. Default - old value"},"type":{"type":"integer","description":"Subscription bundle type. Licences - 1, Seats - 2"},"branches":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateBranches","description":"Array of subscription bundle visibilities"},"groups":{"type":"array","description":"Array of Group IDs to be added to visibilities","items":{"type":"integer"}},"additional_fields":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateAdditionalFields","description":"Array of field_id and value pairs to populate additional fields defined for the Bundle."},"propagate_to_transactions":{"type":"boolean","description":"If true every change in the bundle (add/delete catalog) will be propagated to the transactions (default false)."}}},"LearnSubscriptionbundleUpdateBranches":{},"LearnSubscriptionbundleUpdateAdditionalFields":{"properties":{"field_xxx":{"type":"string","description":"Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."}}},"LearnSubscriptionbundleUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateData","description":"ID of updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleUpdateData":{"required":["updated_bundle","status","data"],"properties":{"updated_bundle":{"type":"integer","description":"Return subscription bundle object"},"status":{"description":"Status 'true' or 'false'","enum":["true","false"],"type":"string"},"data":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateDataL2","description":"Return subscription bundle object"}}},"LearnSubscriptionbundleUpdateDataL2":{"required":["id","name","description","code","published","type","propagate_to_transactions","items","plans","visibility"],"properties":{"id":{"type":"integer","description":"Subscription bundle ID"},"name":{"type":"string","description":"Subscription bundle name"},"description":{"type":"string","description":"Subscription bundle description"},"code":{"type":"string","description":"Subscription bundle code"},"published":{"type":"boolean","description":"Subscription bundle published field"},"type":{"type":"integer","description":"Subscription bundle type (1 - "licenses" or 2 - "seats")"},"propagate_to_transactions":{"type":"boolean","description":"Param that if true propagates to transaction every action on bundle catalogs"},"items":{"type":"array","description":"Subscription bundle items","items":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateItems"}},"plans":{"type":"array","description":"Subscription bundle plans","items":{"$ref":"#/definitions/LearnSubscriptionbundleUpdatePlans"}},"visibility":{"type":"array","description":"Subscription bundle visibility","items":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibility"}}}},"LearnSubscriptionbundleUpdateItems":{"required":["id","item_id","name","description","items_court"],"properties":{"id":{"type":"integer","description":"Subscription item ID"},"item_id":{"type":"integer","description":"Subscription item ID"},"name":{"type":"string","description":"Subscription item name"},"description":{"type":"string","description":"Subscription item description"},"items_court":{"type":"integer","description":"Count of items"}}},"LearnSubscriptionbundleUpdatePlans":{"required":["id","plan_name","price","code","availability","renewal_type","validity_units","validity_period","enforce_limit","idCatalogue","number_courses"],"properties":{"id":{"type":"integer","description":"Subscription plan ID"},"plan_name":{"type":"string","description":"Subscription plan name"},"price":{"type":"number","format":"float","description":"Subscription plan price"},"code":{"type":"string","description":"Subscription plan code"},"availability":{"type":"integer","description":"Subscription plan availability"},"renewal_type":{"type":"integer","description":"Subscription plan renewal type"},"validity_units":{"type":"integer","description":"Subscription plan validity units"},"validity_period":{"type":"integer","description":"Subscription plan validity period"},"enforce_limit":{"type":"integer","description":"Subscription plan enforce limit"},"idCatalogue":{"type":"integer","description":"Id of Catalogue"},"number_courses":{"type":"integer","description":"Number of Courses"}}},"LearnSubscriptionbundleUpdateVisibility":{"required":["id","id_object","selection_status","type","iLeft","iRight","type_label","title"],"properties":{"id":{"type":"integer","description":"Subscription visibility ID"},"id_object":{"type":"integer","description":"ID of the object (branch ID or group ID)"},"selection_status":{"type":"integer","description":"Object (it is meaningful only for Branches) selection status, options: 1 - A single branch is selected, 2 - A branch and all the descendants are selected"},"type":{"type":"integer","description":"Obect type. Options: 1 - branch, 2 - group"},"iLeft":{"type":"integer","description":"Id for the branch node used as the left index of the nested set for the orgchart tree"},"iRight":{"type":"integer","description":"Id for the branch node used as the right index of the nested set for the orgchart tree"},"type_label":{"type":"string","description":"Obect type label, e.g. "branch""},"title":{"type":"string","description":"Title (branch or group)"}}},"LearnSubscriptionbundleUpdateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateLast","description":"Link to the last page"}}},"LearnSubscriptionbundleUpdateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleUpdateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleUpdateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleUpdateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleViewData","description":"Return subscription bundle object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleViewData":{"required":["id","name","description","code","published","type","items"],"properties":{"id":{"type":"integer","description":"Subscription bundle ID"},"name":{"type":"string","description":"Subscription bundle name"},"description":{"type":"string","description":"Subscription bundle description"},"code":{"type":"string","description":"Subscription bundle code"},"published":{"type":"boolean","description":"Subscription bundle published field"},"type":{"type":"integer","description":"Subscription bundle type (1 - "licenses" or 2 - "seats")"},"field_xxx":{"type":"string","description":"Additional field value. In field_xxx, "xxx" is field ID. There are multiple additional fields created using this pattern"},"items":{"type":"array","description":"Subscription bundle items","items":{"$ref":"#/definitions/LearnSubscriptionbundleViewItems"}}}},"LearnSubscriptionbundleViewItems":{"required":["id","item_id","name"],"properties":{"id":{"type":"integer","description":"Subscription item ID"},"item_id":{"type":"integer","description":"Subscription item ID"},"name":{"type":"string","description":"Subscription item name"}}},"LearnSubscriptionbundleViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleViewLast","description":"Link to the last page"}}},"LearnSubscriptionbundleViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleCreateItemsSchema":{"type":"object","properties":{"items":{"type":"array","description":"An array of IDs of the items that are being associated. If this parameter is set, the parameter "select_all" should not be used.","items":{"type":"integer"}},"select_all":{"type":"boolean","description":"Set to TRUE if all available items should be associated with the bundle. If this parameter is set to TRUE, the parameter "items" should not be used. This parameter should not be set to FALSE."},"select_all_text_filter":{"type":"string","description":"Search text filter on select all"}}},"LearnSubscriptionbundleCreateItemsResponse":{"required":["data","version","version","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleCreateItemsData","description":"Array containing the result status"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnSubscriptionbundleCreateItemsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Whether or not the operation was successful"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnSubscriptionbundleDeleteItemResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleDeleteItemData":{"required":["deleted_item"],"properties":{"deleted_item":{"type":"integer","description":"ID of the successfully deleted item"}}},"LearnSubscriptionbundleDeleteItemLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemLast","description":"Link to the last page"}}},"LearnSubscriptionbundleDeleteItemSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleDeleteItemGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleDeleteItemFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleDeleteItemLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleDeleteItemsSchema":{"type":"object","required":["item_ids"],"properties":{"item_ids":{"type":"array","description":"ID of item/s to be deleted","items":{"type":"integer"}}}},"LearnSubscriptionbundleDeleteItemsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleDeleteItemsData":{"required":["errors","deleted"],"properties":{"errors":{"type":"array","description":"Errors during process","items":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsErrors"}},"deleted":{"type":"array","description":"List with successfully deleted items","items":{"type":"integer"}}}},"LearnSubscriptionbundleDeleteItemsErrors":{"required":["id","error"],"properties":{"id":{"type":"integer","description":"The ID of the item requested to process that gene rated an error"},"error":{"type":"string","description":"Details of the error, e.g. item does not exist..."}}},"LearnSubscriptionbundleDeleteItemsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteItemsLast","description":"Link to the last page"}}},"LearnSubscriptionbundleDeleteItemsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleDeleteItemsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleDeleteItemsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleDeleteItemsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleUpdateVisibilityL2Schema":{"type":"object","properties":{"branch_ids":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityBranchIds","description":"Object of Branches to be added as subscription bundle visibilities. The key is branch ID, the value is Branch selection status"},"group_ids":{"type":"array","description":"Array of Group ID to be added as subscription bundle visibilities (e.g. [123,234])","items":{"type":"integer"}}}},"LearnSubscriptionbundleUpdateVisibilityBranchIds":{"required":["n"],"properties":{"n":{"description":"Where n is the id of the branch and the value is the selection status, options: 1 - A single branch is selected, 2 - A branch and all the descendants are selected, example "0": "1"","enum":["1","2"],"type":"integer"}}},"LearnSubscriptionbundleUpdateVisibilityL2Response":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityData","description":"Results of the update process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleUpdateVisibilityData":{"properties":{"errors":{"type":"array","description":"Errors during process","items":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityErrors"}},"bundle_visibilities":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityBundleVisibilities","description":"List with created visibility IDs"}}},"LearnSubscriptionbundleUpdateVisibilityErrors":{"required":["id","error"],"properties":{"id":{"type":"integer","description":"The ID of the branch/group requested to process that generated an error"},"error":{"type":"string","description":"Details of the error, e.g. branch does not exist..."}}},"LearnSubscriptionbundleUpdateVisibilityBundleVisibilities":{"properties":{"branch_ids":{"type":"array","description":"List with created visibility IDs by type "Branch"","items":{"type":"integer"}},"group_ids":{"type":"array","description":"List with created visibility IDs by type "Group"","items":{"type":"integer"}}}},"LearnSubscriptionbundleUpdateVisibilityLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilitySelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleUpdateVisibilityLast","description":"Link to the last page"}}},"LearnSubscriptionbundleUpdateVisibilitySelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleUpdateVisibilityGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleUpdateVisibilityFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleUpdateVisibilityLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleDeleteVisibilityResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteVisibilityData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteVisibilityLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleDeleteVisibilityData":{"required":["deleted_visibility"],"properties":{"deleted_visibility":{"type":"integer","description":"ID of the successfully deleted visibility"}}},"LearnSubscriptionbundleDeleteVisibilityLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteVisibilitySelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteVisibilityGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteVisibilityFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleDeleteVisibilityLast","description":"Link to the last page"}}},"LearnSubscriptionbundleDeleteVisibilitySelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleDeleteVisibilityGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleDeleteVisibilityFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleDeleteVisibilityLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleGetCoursesLpsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleGetCoursesLpsData","description":"List of all retrieved Catalog/Bundle items"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleGetCoursesLpsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleGetCoursesLpsData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of subscription records info objects","items":{"$ref":"#/definitions/LearnSubscriptionbundleGetCoursesLpsItems"}},"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 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/LearnSubscriptionbundleGetCoursesLpsSort"}}}},"LearnSubscriptionbundleGetCoursesLpsItems":{"required":["item_id","item_type","item_code","item_name","item_description","item_category","item_thumbnail","number_of_courses","item_rating","is_new","is_user_enrolled","item_visibility","item_policy","item_can_enroll","is_opened","access_status","price_status"],"properties":{"item_id":{"type":"integer","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_description":{"type":"string","description":"Item description"},"item_category":{"type":"integer","description":"Item category"},"item_language":{"type":"string","description":"Item language. It can be null"},"item_language_code":{"type":"string","description":"Item language code (e.g. "en", "es", "de"). It can be null"},"item_language_label":{"type":"string","description":"Item language label. It can be null"},"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/LearnSubscriptionbundleGetCoursesLpsMultiLanguages"}},"item_thumbnail":{"type":"string","description":"Item thumbnail"},"number_of_courses":{"type":"integer","description":"Number of courses (available only for Learning plans, otherwise NULL will be returned)"},"item_price":{"type":"string","description":"Item price - it is available only if "ecommerce" app is activated"},"affiliate_price":{"type":"string","description":"The content partner price - it is available only if "content partners" app is activated"},"item_rating":{"type":"integer","description":"Item rating (available only for Courses, otherwise NULL will be returned). Not available for Generic catalog"},"is_new":{"type":"integer","description":"Is new (1 or 0 is returned) - indicates if user has already "played" in this Course or Learning plan. Not available for Generic catalog"},"is_user_enrolled":{"type":"integer","description":"Check if logged user is enrolled to course: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"item_visibility":{"type":"integer","description":"Item visibility (0 - Everyone, and show on home page, 1 - Only for logged in users OR 2 - Only users subscribed to the course)"},"item_policy":{"type":"integer","description":"Item policy (0 - Subscriptions are closed, 1 Subscriptions are open OR 2 Subscription is available during the following period)"},"item_can_enroll":{"type":"integer","description":"Item can enroll (0 - Only Admin can subscribe, 1 - Pending Admin Approval OR 2 - Free )"},"is_opened":{"type":"integer","description":"Is course opened for subsription: 0 - false, 1 - true, NULL - n/a (for Learning plans)"},"access_status":{"type":"integer","description":"Options: 1 - enable, 2 - dissable, 3 - expired, NULL - n/a (for Learning plans)"},"quick_course_launch":{"type":"boolean","description":"Whether the course quick enrollment is active."},"price_status":{"type":"integer","description":"Options: 1 - free, 2 - paid, NULL - n/a (for Learning plans)"}}},"LearnSubscriptionbundleGetCoursesLpsMultiLanguages":{"required":["browser_code","code","name"],"properties":{"browser_code":{"type":"string","description":"Code of the course language"},"code":{"type":"string","description":"Name of the course language"},"name":{"type":"string","description":"Label of the course language"}}},"LearnSubscriptionbundleGetCoursesLpsSort":{"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"}}},"LearnSubscriptionbundleGetCoursesLpsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleGetCoursesLpsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleGetCoursesLpsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleGetCoursesLpsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleGetCoursesLpsLast","description":"Link to the last page"}}},"LearnSubscriptionbundleGetCoursesLpsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleGetCoursesLpsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleGetCoursesLpsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleGetCoursesLpsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleItemsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleItemsData","description":"Return subscription bundle items"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleItemsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleItemsData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Subscription bundle items","items":{"$ref":"#/definitions/LearnSubscriptionbundleItemsItems"}},"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/LearnSubscriptionbundleItemsSort"}}}},"LearnSubscriptionbundleItemsItems":{"required":["id","item_id","name","description","items_count"],"properties":{"id":{"type":"string","description":"ID of the row"},"item_id":{"type":"string","description":"Subscription item ID"},"name":{"type":"string","description":"Subscription item name"},"description":{"type":"string","description":"Subscription description"},"items_count":{"type":"string","description":"Number of items"}}},"LearnSubscriptionbundleItemsSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnSubscriptionbundleItemsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleItemsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleItemsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleItemsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleItemsLast","description":"Link to the last page"}}},"LearnSubscriptionbundleItemsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleItemsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleItemsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleItemsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleGetFiltersResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleGetFiltersData","description":"List of all retrieved categories"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleGetFiltersLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleGetFiltersData":{"required":["filters"],"properties":{"filters":{"type":"array","description":"Array of filters","items":{"$ref":"#/definitions/LearnSubscriptionbundleGetFiltersFilters"}}}},"LearnSubscriptionbundleGetFiltersFilters":{},"LearnSubscriptionbundleGetFiltersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleGetFiltersSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleGetFiltersGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleGetFiltersFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleGetFiltersLast","description":"Link to the last page"}}},"LearnSubscriptionbundleGetFiltersSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleGetFiltersGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleGetFiltersFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleGetFiltersLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Subscription bundles to be added","items":{"$ref":"#/definitions/LearnSubscriptionbundleBatchItems"}}}},"LearnSubscriptionbundleBatchItems":{"required":["name","description","code","type"],"properties":{"name":{"type":"string","description":"Subscription bundle name"},"description":{"type":"string","description":"Subscription bundle description"},"code":{"type":"string","description":"Subscription bundle code"},"published":{"type":"integer","description":"Subscription bundle published. Options 0 - not published, 1 - published. Default - 0"},"type":{"description":"Subscription bundle type. Seats - 2, Licences - 1","enum":["1","2"],"type":"integer"},"field_xxx":{"type":"string","description":"Multiple additional fields may be added. Simply replace "xxx" with the right field ID (do not use the "human" additional field name)"},"propagate_to_transactions":{"type":"boolean","description":"If true every change in the bundle (add/delete catalog) will be propagated to the transactions (default false)."}}},"LearnSubscriptionbundleBatchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionbundleBatchData","description":"Array containing the result status"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleBatchData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Whether or not the operation was successful"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnSubscriptionbundleBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleBatchLast","description":"Link to the last page"}}},"LearnSubscriptionbundleBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleItemsBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Subscription items to be added to bundles","items":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchItems"}}}},"LearnSubscriptionbundleItemsBatchItems":{"required":["bundle_code","catalog_code"],"properties":{"bundle_code":{"type":"string","description":"The subscription bundle code. The bundle code should match that of an existing subscription bundle. This item is required."},"catalog_code":{"type":"string","description":"The catalog code. The code should match that of an existing course catalog. This item is required."}}},"LearnSubscriptionbundleItemsBatchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleItemsBatchData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Whether or not the operation was successful"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnSubscriptionbundleItemsBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleItemsBatchLast","description":"Link to the last page"}}},"LearnSubscriptionbundleItemsBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleItemsBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleItemsBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleItemsBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleVisibilityBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Change the visibility for one or more bundles","items":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchItems"}}}},"LearnSubscriptionbundleVisibilityBatchItems":{"required":["bundle_code","item_type","item_code"],"properties":{"bundle_code":{"type":"string","description":"Subscription bundle code"},"item_type":{"type":"string","description":"Subscription bundle item type (Possible values: 'branch', 'group')"},"item_code":{"type":"string","description":"Subscription bundle item code"},"include_descendants":{"type":"boolean","description":"Only valid if item_type is 'branch'"}}},"LearnSubscriptionbundleVisibilityBatchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleVisibilityBatchData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Whether or not the operation was successful"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnSubscriptionbundleVisibilityBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleVisibilityBatchLast","description":"Link to the last page"}}},"LearnSubscriptionbundleVisibilityBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionbundleVisibilityBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionbundleVisibilityBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionbundleVisibilityBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionbundleAssignableItemsResponse":{"required":["data","version","_links","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Return subscription bundle assignable items","items":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsLinksL2","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionbundleAssignableItemsData":{"required":["items"],"properties":{"items":{"type":"array","description":"Catalog items","items":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsItems"}}}},"LearnSubscriptionbundleAssignableItemsLinks":{"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsLast","description":"Link to the last page"},"next":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsNext","description":"Go to next page number"},"prev":{"$ref":"#/definitions/LearnSubscriptionbundleAssignableItemsPrev","description":"Go to previous page number"}},"required":["self","goto","first","last"]},"LearnSubscriptionbundleAssignableItemsSelf":{"properties":{"href":{"type":"string","required":"required","description":"Url of the current page"}},"required":["href"]},"LearnSubscriptionbundleAssignableItemsGoto":{"properties":{"href":{"type":"string","required":"required","description":"Url of the specific page"}},"required":["href"]},"LearnSubscriptionbundleAssignableItemsFirst":{"properties":{"href":{"type":"string","required":"required","description":"Url of the first page"}},"required":["href"]},"LearnSubscriptionbundleAssignableItemsLast":{"properties":{"href":{"type":"string","required":"required","description":"Url of the last page"}},"required":["href"]},"LearnSubscriptionbundleAssignableItemsNext":{"properties":{"href":{"type":"string","required":"required","description":"Url of the next page"}},"required":["href"]},"LearnSubscriptionbundleAssignableItemsPrev":{"properties":{"href":{"type":"string","required":"required","description":"Url of the previous page"}},"required":["href"]},"LearnSubscriptionbundleAssignableItemsItems":{"required":["catalogue_id","catalogue_name"],"properties":{"catalogue_id":{"type":"integer","description":"Subscription item ID"},"catalogue_name":{"type":"string","description":"Subscription item name"},"catalogue_description":{"type":"string","description":"Subscription item description"},"catalogue_code":{"type":"string","description":"Subscription item Code"},"items_count":{"type":"integer","description":"Subscription item courses assigned"}}},"LearnSubscriptionbundleAssignableItemsLinksL2":{},"LearnSubscriptionfieldCreateSchema":{"type":"object","required":["type","subscription_type","translations"],"properties":{"type":{"description":"Subscription field type.","enum":["date","dropdown","text"],"type":"string"},"subscription_type":{"description":"Subscription object type.","enum":["bundle","plan"],"type":"string"},"translations":{"$ref":"#/definitions/LearnSubscriptionfieldCreateTranslations","description":"Array of translations, the system default language translation is mandatory. The key is code of the language or all - the value is title. For example en, all"},"mandatory":{"type":"integer","description":"Mandatory - 1 or Not mandatory - 0. Default - 0"},"dropdown_options":{"type":"array","description":"Array of dropdown options. If type of user field is dropdown, this parameter becomes required","items":{"$ref":"#/definitions/LearnSubscriptionfieldCreateDropdownOptions"}}}},"LearnSubscriptionfieldCreateTranslations":{},"LearnSubscriptionfieldCreateDropdownOptions":{"required":["translations"],"properties":{"translations":{"$ref":"#/definitions/LearnSubscriptionfieldCreateTranslationsL2","description":"Array of translations, the system default language translation is mandatory. The key is the language or all - the value is title. For example english, all"}}},"LearnSubscriptionfieldCreateTranslationsL2":{},"LearnSubscriptionfieldCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionfieldCreateData","description":"ID of the created record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionfieldCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionfieldCreateData":{"properties":{"count":{"type":"integer","required":"required","description":"Total number of items returned"},"cursor":{"type":"string","required":"optional","description":"Unique ID used to temporarily store search parameters. This field is to be considered as deprecated and it will be removed in a future release."},"has_more_data":{"type":"boolean","required":"required","description":"True if the current page is not the last page"},"current_page":{"type":"integer","required":"required","description":"Page number of the current page"},"current_page_size":{"type":"integer","required":"required","description":"Number of items per page"},"total_page_count":{"type":"integer","required":"optional","description":"Total number of pages returned"},"total_count":{"type":"integer","required":"optional","description":"Total number of Items"},"field_id":{"type":"integer","description":"The internal ID for the newly created subscription field"}},"required":["count","has_more_data","current_page","current_page_size","field_id"]},"LearnSubscriptionfieldCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionfieldCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionfieldCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionfieldCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionfieldCreateLast","description":"Link to the last page"}}},"LearnSubscriptionfieldCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionfieldCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionfieldCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionfieldCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionfieldDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteData","description":"Response data object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionfieldDeleteData":{"required":["deleted_id"],"properties":{"deleted_id":{"type":"integer","description":"The internal ID of deleted field"}}},"LearnSubscriptionfieldDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteLast","description":"Link to the last page"}}},"LearnSubscriptionfieldDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionfieldDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionfieldDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionfieldDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionfieldIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionfieldIndexData","description":"List of all retrieved user fields"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionfieldIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionfieldIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of user fields info objects","items":{"$ref":"#/definitions/LearnSubscriptionfieldIndexItems"}},"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/LearnSubscriptionfieldIndexSort"}}}},"LearnSubscriptionfieldIndexItems":{"required":["id","title","type","mandatory","position"],"properties":{"id":{"type":"integer","description":"ID of the subscription field"},"title":{"type":"string","description":"Subscription field title in the selected language"},"type":{"type":"string","description":"Type of the subscription field"},"mandatory":{"type":"string","description":"Subscription field mandatory"},"position":{"type":"integer","description":"Subscription field order"},"subscription_type":{"type":"boolean","description":"If this field is inherited from parent branch or branches"},"options":{"type":"array","description":"If this field is from type 'dropdown' here show the options","items":{"$ref":"#/definitions/LearnSubscriptionfieldIndexOptions"}}}},"LearnSubscriptionfieldIndexOptions":{"properties":{"id":{"type":"integer","description":"Id of option"},"label":{"type":"string","description":"Translatable title of option"},"value":{"type":"integer","description":"Id of option"}}},"LearnSubscriptionfieldIndexSort":{"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"}}},"LearnSubscriptionfieldIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionfieldIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionfieldIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionfieldIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionfieldIndexLast","description":"Link to the last page"}}},"LearnSubscriptionfieldIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionfieldIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionfieldIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionfieldIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionfieldUpdateSchema":{"type":"object","properties":{"mandatory":{"description":"Flag if its mandatory","enum":["0","1"],"type":"integer"},"position":{"type":"integer","description":"The position of the field."},"translations":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateTranslations","description":"Object of translations, the system default language translation is mandatory. The key is code of the language or all - the value is title. For example en, all"},"dropdown_options":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateDropdownOptions","description":"Array of objects containing dropdown options. If type is dropdown this parameter becomes required"}}},"LearnSubscriptionfieldUpdateTranslations":{},"LearnSubscriptionfieldUpdateDropdownOptions":{"properties":{"updated":{"type":"array","description":"Updated options","items":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateUpdated"}},"deleted":{"type":"array","description":"Ids of deleted Deleted options","items":{"type":"integer"}},"new":{"type":"array","description":"New options","items":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateNew"}}}},"LearnSubscriptionfieldUpdateUpdated":{"properties":{"id_option":{"type":"integer","description":"Id of selected dropdown option."},"translations":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateTranslationsL2","description":"Array of translations, the system default language translation is mandatory. The key is code of the language or all - the value is title. For example en, all"}},"required":["translations"]},"LearnSubscriptionfieldUpdateTranslationsL2":{},"LearnSubscriptionfieldUpdateNew":{"required":["translations"],"properties":{"translations":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateTranslationsL3","description":"Array of translations, the system default language translation is mandatory. The key is code of the language or all - the value is title. For example en, all"}}},"LearnSubscriptionfieldUpdateTranslationsL3":{},"LearnSubscriptionfieldUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionfieldUpdateData":{"required":["field_id"],"properties":{"field_id":{"type":"integer","description":"Id of user field."},"error_messages":{"type":"array","description":"List of errors.","items":{"type":"string"}},"updated_option_ids":{"type":"array","description":"List of updated ids.","items":{"type":"integer"}}}},"LearnSubscriptionfieldUpdateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionfieldUpdateLast","description":"Link to the last page"}}},"LearnSubscriptionfieldUpdateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionfieldUpdateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionfieldUpdateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionfieldUpdateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionfieldViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionfieldViewData","description":"Response data object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionfieldViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionfieldViewData":{"required":["id_field","field_type","sequence","mandatory","subscription_type","translations"],"properties":{"id_field":{"type":"integer","description":"The internal ID of the field"},"field_type":{"type":"string","description":"The field type ('text', 'date' or 'dropdown')"},"sequence":{"type":"integer","description":"The field order"},"mandatory":{"type":"boolean","description":"The is field mandatory"},"subscription_type":{"type":"string","description":"The Subscription type of the field ('bundle' or 'plan')"},"translations":{"$ref":"#/definitions/LearnSubscriptionfieldViewTranslations","description":"The Subscription field translations, e.g. {"bg": "bg dropdown", "it": "it dropdown"}. The key is language code the value is translation"},"dropdown_options":{"$ref":"#/definitions/LearnSubscriptionfieldViewDropdownOptions","description":"The dropdown options data, e.g. "dropdown_options": { "1": {"translations": {"bg": "bg option 1", "en": "en option 1"},"sequence": "1"}, "2": {"translations": {"bg": "bg option 2", "en": "en option 2"},"sequence": "2"} }. The dropdown options data - the key is ID of option, the value is object containing translations and sequence"}}},"LearnSubscriptionfieldViewTranslations":{},"LearnSubscriptionfieldViewDropdownOptions":{},"LearnSubscriptionfieldViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionfieldViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionfieldViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionfieldViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionfieldViewLast","description":"Link to the last page"}}},"LearnSubscriptionfieldViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionfieldViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionfieldViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionfieldViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionfieldDeleteMultipleSchema":{"type":"object","properties":{"field_ids":{"type":"array","description":"Field IDs. NB! Is mandatory parameter if is not provided 'selected_all' parameter","items":{"type":"integer"}},"selected_all":{"type":"boolean","description":"If is provided, it will be deleted all Subscription fields in the LMS!"}}},"LearnSubscriptionfieldDeleteMultipleResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteMultipleData","description":"Response data object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteMultipleLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionfieldDeleteMultipleData":{"required":["deleted","not_deleted"],"properties":{"deleted":{"type":"array","description":"The internal IDs of deleted fields","items":{"type":"integer"}},"not_deleted":{"type":"array","description":"The IDs of not deleted fields","items":{"type":"integer"}}}},"LearnSubscriptionfieldDeleteMultipleLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteMultipleSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteMultipleGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteMultipleFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionfieldDeleteMultipleLast","description":"Link to the last page"}}},"LearnSubscriptionfieldDeleteMultipleSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionfieldDeleteMultipleGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionfieldDeleteMultipleFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionfieldDeleteMultipleLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionplanCreateSchema":{"type":"object","required":["bundle_id","plan_name","price","availability","renewal_type","validity_units","validity_period","enforce_limit"],"properties":{"bundle_id":{"type":"integer","description":"Subscription Bundle ID"},"code":{"type":"string","description":"Subscription plan code"},"plan_name":{"type":"string","description":"Subscription plan name"},"price":{"type":"number","format":"float","description":"Subscription plan price"},"availability":{"type":"integer","description":"Subscription plan availability"},"renewal_type":{"type":"integer","description":"Subscription plan renewal type. None - 1, Manual - 2, Automatic - 3"},"validity_units":{"type":"integer","description":"Subscription plan validity units. Day - 1, Month - 2, Year - 3"},"validity_period":{"type":"integer","description":"Subscription plan validity period"},"enforce_limit":{"type":"integer","description":"Subscription plan enforce limit. True - 1, False - 0"},"additional_fields":{"$ref":"#/definitions/LearnSubscriptionplanCreateAdditionalFields","description":"Array of field_id and value pairs to populate additional fields defined for the plan."}}},"LearnSubscriptionplanCreateAdditionalFields":{"properties":{"field_xxx":{"type":"string","description":"Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."}}},"LearnSubscriptionplanCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionplanCreateData","description":"ID of the created record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionplanCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionplanCreateData":{"required":["plan_id"],"properties":{"plan_id":{"type":"integer","description":"The internal ID for the newly created Subscription plan"}}},"LearnSubscriptionplanCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionplanCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionplanCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionplanCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionplanCreateLast","description":"Link to the last page"}}},"LearnSubscriptionplanCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionplanCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionplanCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionplanCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionplanPurchaseSchema":{"type":"object","properties":{"record_id":{"type":"integer","description":"ID of the subscription record"},"automatic_renew_only":{"type":"boolean","description":"Get automatic renew records only"}}},"LearnSubscriptionplanPurchaseResponse":{"required":["finished","version"],"properties":{"finished":{"type":"boolean","description":"Whether the purchase was successful"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnSubscriptionplanDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionplanDeleteData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionplanDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionplanDeleteData":{"required":["error","deleted_plan"],"properties":{"error":{"$ref":"#/definitions/LearnSubscriptionplanDeleteError","description":"Errors during process"},"deleted_plan":{"type":"string","description":"ID of the successfully deleted item"}}},"LearnSubscriptionplanDeleteError":{"required":["message","plan_records"],"properties":{"message":{"type":"integer","description":"Process that generated an error"},"plan_records":{"type":"string","description":"Subscription plan records"}}},"LearnSubscriptionplanDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionplanDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionplanDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionplanDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionplanDeleteLast","description":"Link to the last page"}}},"LearnSubscriptionplanDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionplanDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionplanDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionplanDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionplanIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionplanIndexData","description":"List of all retrieved subscription plans"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionplanIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionplanIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of subscription plan info objects","items":{"$ref":"#/definitions/LearnSubscriptionplanIndexItems"}},"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/LearnSubscriptionplanIndexSort"}}}},"LearnSubscriptionplanIndexItems":{"required":["plan_id","plan_name","code","bundle_type","renewal_type","availability","validity_units","validity_period","plan_price","bundle_id","bundle_title","bundle_description","bundle_code","bundle_type","duration","actions","enforce_limit"],"properties":{"plan_id":{"type":"integer","description":"ID of the subscription plan"},"plan_name":{"type":"string","description":"Name of the subscription plan"},"code":{"type":"string","description":"Subscription plan code"},"bundle_type":{"description":"Bundle type (1 - seat, 2 - licences)","enum":["1","2"],"type":"integer"},"renewal_type":{"type":"string","description":"Subscription plan renewal type"},"availability":{"type":"integer","description":"Subscription plan availability"},"validity_units":{"type":"integer","description":"Subscription plan validity_units (1 - days, 2 - months, 3 - years)"},"validity_period":{"type":"integer","description":"Subscription plan validity period"},"plan_price":{"type":"integer","description":"Subscription plan price"},"bundle_id":{"type":"integer","description":"ID of the subscription plan bundle"},"bundle_title":{"type":"string","description":"Title of the subscription plan bundle"},"bundle_description":{"type":"string","description":"Description of the subscription plan bundle"},"bundle_code":{"type":"string","description":"Code of the subscription plan"},"field_1111":{"type":"string","description":"Additional field value. In field_1111, "1111" is field ID. There are multiple additional fields created using this pattern"},"duration":{"type":"string","description":"Plan duration (e.g. "2 days")"},"actions":{"type":"array","description":"Actions that current user can perform (e.g. "delete", "edit", etc.)","items":{"type":"string"}},"enforce_limit":{"description":"Enforce the limit of the subscription plan","enum":["0","1"],"type":"integer"},"ecommerce_pricing_system_default":{"type":"integer","description":"The default ecommerce pricing system id"}}},"LearnSubscriptionplanIndexSort":{"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"}}},"LearnSubscriptionplanIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionplanIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionplanIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionplanIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionplanIndexLast","description":"Link to the last page"}}},"LearnSubscriptionplanIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionplanIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionplanIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionplanIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionplanUpdateSchema":{"type":"object","properties":{"code":{"type":"string","description":"Subscription plan code"},"plan_name":{"type":"string","description":"Subscription plan name"},"price":{"type":"number","format":"float","description":"Subscription plan price"},"availability":{"type":"integer","description":"Subscription plan availability"},"renewal_type":{"description":"Subscription plan renewal type. None - 1, Manual - 2, Automatic -","enum":["1","2","3"],"type":"integer"},"validity_units":{"description":"Subscription plan validity units. Day - 1, Month - 2, Year - 3","enum":["1","2","3"],"type":"integer"},"validity_period":{"type":"integer","description":"Subscription plan validity period"},"enforce_limit":{"description":"Subscription plan enforce limit. True - 1, False - 0","enum":["0","1"],"type":"integer"},"additional_fields":{"$ref":"#/definitions/LearnSubscriptionplanUpdateAdditionalFields","description":"Array of field_id and value pairs to populate additional fields"}}},"LearnSubscriptionplanUpdateAdditionalFields":{"properties":{"field_xxx":{"type":"string","description":"Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an"}}},"LearnSubscriptionplanUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionplanUpdateData","description":"ID of the updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionplanUpdateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionplanUpdateData":{"required":["plan_id"],"properties":{"plan_id":{"type":"integer","description":"The internal ID for the updated Subscription plan"}}},"LearnSubscriptionplanUpdateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionplanUpdateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionplanUpdateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionplanUpdateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionplanUpdateLast","description":"Link to the last page"}}},"LearnSubscriptionplanUpdateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionplanUpdateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionplanUpdateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionplanUpdateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionplanViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionplanViewData","description":"Return Subscription plan object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionplanViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionplanViewData":{"required":["id","code","plan_name","bundle_id","price","availability","renewal_type","validity_units","validity_period","enforce_limit","subscription_records","number_of_courses"],"properties":{"id":{"type":"integer","description":"Subscription plan ID"},"code":{"type":"string","description":"Subscription plan code"},"plan_name":{"type":"string","description":"Subscription plan name"},"bundle_id":{"type":"integer","description":"Subscription plan ID"},"price":{"type":"number","format":"float","description":"Subscription plan price"},"availability":{"type":"integer","description":"Subscription plan availability"},"renewal_type":{"type":"integer","description":"Subscription plan renewal type (1 - "none", 2 - "manual" or 3 - "automatic")"},"validity_units":{"type":"integer","description":"Subscription plan validity units (1 - "day", 2 - "month" or 3 - "year")"},"validity_period":{"type":"integer","description":"Subscription plan validity period"},"enforce_limit":{"type":"integer","description":"Subscription plan enforce limit (0 - false or 1 - true)"},"field_xxx":{"type":"string","description":"Additional field value. In field_xxx, "xxx" is field ID. There are multiple"},"subscription_records":{"type":"array","description":"Subscription plan records","items":{"$ref":"#/definitions/LearnSubscriptionplanViewSubscriptionRecords"}},"number_of_courses":{"type":"integer","description":"Number of course in the subscription plan"}}},"LearnSubscriptionplanViewSubscriptionRecords":{"required":["id","name","plan_id","branch_id","record_type","start_date","end_date","status","type","availability","users_associated","enrollments_done","notes","created_by","created_on","bundle_id","price","code"],"properties":{"id":{"type":"integer","description":"Subscription record ID"},"name":{"type":"string","description":"Subscription record name"},"plan_id":{"type":"integer","description":"Subscription plan ID"},"branch_id":{"type":"integer","description":"Subscription plan branch ID"},"record_type":{"type":"integer","description":"Subscription record type (1 for "new" or 2 for "renew")"},"start_date":{"type":"string","format":"date","description":"Subscription record start date"},"end_date":{"type":"string","format":"date","description":"Subscription record end date"},"status":{"type":"integer","description":"Subscription record status - 1 (active) or 2 (inactive)"},"type":{"type":"integer","description":"Subscription record type (1 - seats or 2 - licences)"},"availability":{"type":"integer","description":"Subscription record availability"},"users_associated":{"type":"integer","description":"Subscription record count users associated"},"enrollments_done":{"type":"integer","description":"Subscription record count enrollments done"},"notes":{"type":"string","description":"Subscription record notes"},"created_by":{"type":"integer","description":"Subscription record created by user ID"},"created_on":{"type":"string","format":"date","description":"Subscription record creation date"},"bundle_id":{"type":"integer","description":"Subscription record bundle ID"},"price":{"type":"integer","description":"Subscription record price"},"code":{"type":"string","description":"Subscription record code"}}},"LearnSubscriptionplanViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionplanViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionplanViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionplanViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionplanViewLast","description":"Link to the last page"}}},"LearnSubscriptionplanViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionplanViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionplanViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionplanViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionplanBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Subscription plans to be added","items":{"$ref":"#/definitions/LearnSubscriptionplanBatchItems"}}}},"LearnSubscriptionplanBatchItems":{"required":["bundle_code","code","name","price","availability","renewal_type","validity_units","validity_period","enforce_limit"],"properties":{"bundle_code":{"type":"string","description":"Subscription bundle code"},"code":{"type":"string","description":"Subscription plan code"},"name":{"type":"string","description":"Subscription plan name"},"price":{"type":"string","description":"Subscription plan price"},"availability":{"type":"integer","description":"Subscription plan availability"},"renewal_type":{"type":"string","description":"Possible values: 'none', 'manual', 'automatic'"},"validity_units":{"type":"string","description":"Possible values: 'day', 'month', 'year'"},"validity_period":{"type":"integer","description":"Subscription plan validity period"},"enforce_limit":{"type":"boolean","description":"Enforce limit"},"field_xxx":{"type":"string","description":"Multiple additional fields may be added. Simply replace "xxx" with the right field ID (do not use the "human" additional field name)"}}},"LearnSubscriptionplanBatchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/LearnSubscriptionplanBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionplanBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionplanBatchData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Whether or not the operation was successful"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnSubscriptionplanBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionplanBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionplanBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionplanBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionplanBatchLast","description":"Link to the last page"}}},"LearnSubscriptionplanBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionplanBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionplanBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionplanBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordCreateSchema":{"type":"object","properties":{"name":{"type":"string","description":"Subscription record name - if it is not provided it will be taken from Subscription bundle name"},"code":{"type":"string","description":"Subscription record code"},"plan_id":{"type":"integer","description":"Subscription plan ID"},"object_id":{"type":"integer","description":"Object ID (user, group or branch ID)"},"selection_status":{"type":"integer","description":"Subscription record object selection status - 1 - Single, 2 - with children"},"record_type":{"description":"Subscription record type (1 - licenses or 2 - seats)","enum":["1","2"],"type":"integer"},"start_date":{"type":"string","format":"date","description":"Subscription record start date"},"skip_sub_mandatory_fields":{"type":"boolean","description":"If we want to skip a check of additional subscription fields. Default value is 'false'."},"availability":{"type":"integer","description":"Subscription record availability"},"status":{"description":"Subscription record status (1 - active or 2 - inactive). Default is "active"","enum":["1","2"],"type":"integer"},"price":{"type":"integer","description":"Subscription record price. If price is not privided it will be taken from the Subscrioption plan"},"notes":{"type":"string","description":"Subscription record notes"},"items":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItems","description":"Object with keys subscription record item id and value item type (options: 1 - course, 2 - catalog, 3 - learning plan). The key XX is item ID and the value is item type e.g. - "items": {"101": 1} (course with ID 101)"},"renewal":{"type":"integer","description":"Subscription record renewal"},"object_type":{"description":"Subscription record assigned to either branch,group or user (1 - branch, 2 - group , 3 - user) *","enum":["1","2","3"],"type":"integer"},"plan_fields":{"$ref":"#/definitions/LearnSubscriptionrecordCreatePlanFields","description":"Array of field_id and value pairs to populate additional fields defined for the plan."},"bundle_fields":{"$ref":"#/definitions/LearnSubscriptionrecordCreateBundleFields","description":"Array of field_id and value pairs to populate additional fields defined for the bundle."}},"required":["plan_id","object_id","selection_status","record_type","start_date","items","object_type"]},"LearnSubscriptionrecordCreateItems":{},"LearnSubscriptionrecordCreatePlanFields":{"properties":{"field_xxx":{"type":"string","description":"Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."}}},"LearnSubscriptionrecordCreateBundleFields":{"properties":{"field_xxx":{"type":"string","description":"Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."}}},"LearnSubscriptionrecordCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordCreateData","description":"ID of the created record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordCreateData":{"required":["record_id"],"properties":{"record_id":{"type":"integer","description":"The internal ID for the newly created Subscription record"},"invalid_items":{"type":"array","description":"If there is invalid items, they will be returned as error masages array","items":{"type":"string"}}}},"LearnSubscriptionrecordCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordCreateLast","description":"Link to the last page"}}},"LearnSubscriptionrecordCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordRenewSchema":{"type":"object","required":["start_date","endDate"],"properties":{"start_date":{"type":"string","format":"date","description":"start_date should have the format of either YYYY-MM-DD (the time will default to 00:00:00) or YYYY-MM-DD hh:mm:ss"},"endDate":{"type":"string","format":"date","description":"endDate should have the format of either YYYY-MM-DD (the time will default to 00:00:00) or YYYY-MM-DD hh:mm:ss"}}},"LearnSubscriptionrecordRenewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordRenewData","description":"ID of the updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordRenewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordRenewData":{"required":["record_id","new_record_id"],"properties":{"record_id":{"type":"integer","description":"The internal ID for the renewed Subscription record"},"new_record_id":{"type":"integer","description":"The internal ID for the newly created Subscription record"}}},"LearnSubscriptionrecordRenewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordRenewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordRenewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordRenewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordRenewLast","description":"Link to the last page"}}},"LearnSubscriptionrecordRenewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordRenewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordRenewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordRenewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteData","description":"ID of the deleted record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordDeleteData":{"required":["record_id"],"properties":{"record_id":{"type":"integer","description":"The internal ID of the deleted Subscription record"}}},"LearnSubscriptionrecordDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteLast","description":"Link to the last page"}}},"LearnSubscriptionrecordDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordIndexData","description":"List of all retrieved subscription records"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordIndexData":{"required":["items"],"properties":{"items":{"type":"array","description":"Array of subscription records info objects","items":{"$ref":"#/definitions/LearnSubscriptionrecordIndexItems"}}}},"LearnSubscriptionrecordIndexItems":{"required":["record_id","record_name","plan_id","object_id","selection_status","record_type","start_date","end_date","status","type","availability","users_associated","enrollments_done","notes","created_by","created_on","bundle_id","price","code","renewal_type","sub_items","plan_fields","bundle_fields","count","has_more_data","current_page","current_page_size"],"properties":{"record_id":{"type":"integer","description":"ID of the subscription record"},"record_name":{"type":"string","description":"Subscription record name"},"plan_id":{"type":"integer","description":"Subscription plan ID"},"object_id":{"type":"integer","description":"Subscription object ID"},"selection_status":{"type":"integer","description":"Subscription object selection status: 1 - Single, 2 - with children"},"record_type":{"type":"integer","description":"Subscription purchase type: 1 - ecommerce, 2 - admin"},"start_date":{"type":"string","format":"date","description":"Subscription record start date"},"end_date":{"type":"string","format":"date","description":"Subscription record end date"},"status":{"type":"integer","description":"Subscription record integer - 1 (active) or 2 (inactive)"},"type":{"type":"integer","description":"Subscription record type (1 - seats or 2 - licences)"},"availability":{"type":"integer","description":"Subscription record availability"},"users_associated":{"type":"integer","description":"Subscription record count users associated"},"enrollments_done":{"type":"integer","description":"Subscription record count enrollments done"},"notes":{"type":"integer","description":"Subscription record notes"},"created_by":{"type":"integer","description":"Subscription record created by user ID"},"created_on":{"type":"integer","description":"Subscription record creation date"},"bundle_id":{"type":"integer","description":"Subscription record bundle ID"},"price":{"type":"integer","description":"Subscription record price"},"code":{"type":"string","description":"Subscription record code"},"renewal_type":{"type":"integer","description":"Subscription renewal type: 1- None, 2 - Manual, 3 - Automatic"},"sub_items":{"$ref":"#/definitions/LearnSubscriptionrecordIndexSubItems","description":"Array of subscription record items info objects"},"plan_fields":{"$ref":"#/definitions/LearnSubscriptionrecordIndexPlanFields","description":"Array of subscription record additional fields for plan info objects"},"bundle_fields":{"$ref":"#/definitions/LearnSubscriptionrecordIndexBundleFields","description":"Array of subscription record additional fields for bundle info objects"},"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/LearnSubscriptionrecordIndexSort"}}}},"LearnSubscriptionrecordIndexSubItems":{"required":["id","record_id","item_id","item_type"],"properties":{"id":{"type":"integer","description":"Subscription item ID"},"record_id":{"type":"integer","description":"Subscription record ID"},"item_id":{"type":"integer","description":"ID of the item (course ID, catalog ID or learning plan ID)"},"item_type":{"type":"integer","description":"Subscription record item type (1 - Course, 2 - Catalog or 3 - Learning plan)"}}},"LearnSubscriptionrecordIndexPlanFields":{"properties":{"field_xxx":{"type":"string","description":"Additional field value. In field_xxx, "xxx" is field ID. There are multiple additional fields created using this pattern"}}},"LearnSubscriptionrecordIndexBundleFields":{"properties":{"field_xxx":{"type":"string","description":"Additional field value. In field_xxx, "xxx" is field ID. There are multiple additional fields created using this pattern"}}},"LearnSubscriptionrecordIndexSort":{"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"}}},"LearnSubscriptionrecordIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordIndexLast","description":"Link to the last page"}}},"LearnSubscriptionrecordIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordUpdateSchema":{"type":"object","properties":{"plan_id":{"type":"integer","description":"Subscription plan ID"},"name":{"type":"string","description":"Subscription record name"},"code":{"type":"string","description":"Subscription record code"},"object_id":{"type":"integer","description":"Subscription record object"},"object_type":{"description":"Subscription record assigned to either branch,group or user (1 - branch, 2 - group , 3 - user)","enum":["1","2","3"],"type":"integer"},"record_type":{"description":"Subscription purchase type: 1 - ecommerce, 2 - admin","enum":["1","2"],"type":"integer"},"selection_status":{"description":"Subscription record branch selection status - 1 - Single, 2 - with children","enum":["1","2"],"type":"integer"},"start_date":{"type":"string","format":"date","description":"Subscription record start date"},"end_date":{"type":"string","format":"date","description":"Subscription record end date"},"status":{"description":"Subscription record status - 1 (active) or 2 (inactive)","enum":["1","2"],"type":"integer"},"availability":{"type":"integer","description":"Subscription record availability"},"notes":{"type":"string","description":"Subscription record notes"},"subscription_bundle_id":{"type":"string","description":"Subscription record bundle ID"},"price":{"type":"integer","description":"Subscription record price"},"items":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateItems","description":"Array with keys subscription record item id and value item type (options: 1 - course, 2 - catalog, 3 - learning plan)"},"plan_fields":{"$ref":"#/definitions/LearnSubscriptionrecordUpdatePlanFields","description":"Array of field_id and value pairs to populate additional fields defined for the plan."},"bundle_fields":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateBundleFields","description":"Array of field_id and value pairs to populate additional fields defined for the bundle."}},"required":["record_type","selection_status","items"]},"LearnSubscriptionrecordUpdateItems":{"required":["xx"],"properties":{"xx":{"type":"integer","description":"The key XX is item ID and the value is item type e.g. - "items": {"101": 1} (course with ID 101)"}}},"LearnSubscriptionrecordUpdatePlanFields":{"properties":{"field_xxx":{"type":"string","description":"Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."}}},"LearnSubscriptionrecordUpdateBundleFields":{"properties":{"field_xxx":{"type":"string","description":"Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."}}},"LearnSubscriptionrecordUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateData","description":"ID of the updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordUpdateData":{"required":["record_id"],"properties":{"record_id":{"type":"integer","description":"The internal ID for the updated Subscription record"},"invalid_items":{"type":"array","description":"If there is invalid items, they will be returned as error masages array","items":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateInvalidItems"}}}},"LearnSubscriptionrecordUpdateInvalidItems":{"properties":{"items":{"type":"array","description":"Updated items","items":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateItemsL2"}}}},"LearnSubscriptionrecordUpdateItemsL2":{"required":["id","name","item_id"],"properties":{"id":{"type":"integer","description":"ID of the row"},"name":{"type":"string","description":"Catalog name"},"item_id":{"type":"integer","description":"ID of the item"}}},"LearnSubscriptionrecordUpdateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordUpdateLast","description":"Link to the last page"}}},"LearnSubscriptionrecordUpdateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordUpdateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordUpdateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordUpdateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordViewData","description":"ID of the updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordViewData":{"required":["subscription_record","sub_items"],"properties":{"subscription_record":{"$ref":"#/definitions/LearnSubscriptionrecordViewSubscriptionRecord","description":"Subscription record information"},"sub_items":{"$ref":"#/definitions/LearnSubscriptionrecordViewSubItems","description":""}}},"LearnSubscriptionrecordViewSubscriptionRecord":{"required":["id","name","plan_id","object_id","selection_status","record_type","start_date","end_date","status","type","availability","users_associated","enrollments_done","notes","created_by","created_on","bundle_id","price","code","renewal_type","plan_fields","bundle_fields"],"properties":{"id":{"type":"integer","description":"Subscription record ID"},"name":{"type":"string","description":"Subscription record name"},"plan_id":{"type":"integer","description":"Subscription plan ID"},"object_id":{"type":"integer","description":"Object ID (user, group or branch ID)"},"selection_status":{"type":"integer","description":"Subscription branch selection status: 1 - Single, 2 - with children"},"record_type":{"type":"integer","description":"Subscription purchase type: 1 - ecommerce, 2 - admin"},"start_date":{"type":"string","format":"date","description":"Subscription record start date"},"end_date":{"type":"string","format":"date","description":"Subscription record end date"},"status":{"type":"integer","description":"Subscription record status - 1 (active) or 2 (inactive)"},"type":{"type":"integer","description":"Subscription record type (1 - licences or 2 - seats)"},"availability":{"type":"integer","description":"Subscription record availability"},"users_associated":{"type":"integer","description":"Subscription record count users associated"},"enrollments_done":{"type":"integer","description":"Subscription record count enrollments done"},"notes":{"type":"string","description":"Subscription record notes"},"created_by":{"type":"integer","description":"Subscription record created by user ID"},"created_on":{"type":"string","format":"date","description":"Subscription record creation date"},"bundle_id":{"type":"integer","description":"Subscription record bundle ID"},"price":{"type":"integer","description":"Subscription record price"},"code":{"type":"string","description":"Subscription record code"},"renewal_type":{"type":"integer","description":"Subscription renewal type: 1- None, 2 - Manual, 3 - Automatic"},"plan_fields":{"$ref":"#/definitions/LearnSubscriptionrecordViewPlanFields","description":"Array of subscription record additional fields for plan info objects"},"bundle_fields":{"$ref":"#/definitions/LearnSubscriptionrecordViewBundleFields","description":"Array of subscription record additional fields for bundle info objects"}}},"LearnSubscriptionrecordViewPlanFields":{"properties":{"field_xxx":{"type":"string","description":"Additional field value. In field_xxx, "xxx" is field ID. There are multiple additional fields created using this pattern"}}},"LearnSubscriptionrecordViewBundleFields":{"properties":{"field_xxx":{"type":"string","description":"Additional field value. In field_xxx, "xxx" is field ID. There are multiple additional fields created using this pattern"}}},"LearnSubscriptionrecordViewSubItems":{"required":["id","name","item_id"],"properties":{"id":{"type":"integer","description":"Subscription record item ID"},"name":{"type":"string","description":"Subscription record catalog name"},"item_id":{"type":"integer","description":"Subscription record catalog ID"}}},"LearnSubscriptionrecordViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordViewLast","description":"Link to the last page"}}},"LearnSubscriptionrecordViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordCreateItemSchema":{"type":"object","required":["item_type","item_id"],"properties":{"item_type":{"description":"Item type options: 1 - course, 2 - catalog, 3 - learning plan","enum":["1","2","3"],"type":"integer"},"item_id":{"type":"integer","description":"Unique ID of the item that is being associated"}}},"LearnSubscriptionrecordCreateItemResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItemData","description":"ID of new record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItemLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordCreateItemData":{"required":["created_item_id"],"properties":{"created_item_id":{"type":"integer","description":"The internal ID for the newly created subscription record item"}}},"LearnSubscriptionrecordCreateItemLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItemSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItemGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItemFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordCreateItemLast","description":"Link to the last page"}}},"LearnSubscriptionrecordCreateItemSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordCreateItemGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordCreateItemFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordCreateItemLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordDeleteItemResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordDeleteItemData":{"required":["deleted_item"],"properties":{"deleted_item":{"type":"integer","description":"ID of the successfully deleted item"}}},"LearnSubscriptionrecordDeleteItemLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemLast","description":"Link to the last page"}}},"LearnSubscriptionrecordDeleteItemSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordDeleteItemGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordDeleteItemFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordDeleteItemLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordDeleteItemsSchema":{"type":"object","required":["item_ids"],"properties":{"item_ids":{"type":"array","description":"ID of item/s to be deleted","items":{"type":"integer"}}}},"LearnSubscriptionrecordDeleteItemsResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsData","description":"Results of the delete process"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordDeleteItemsData":{"required":["errors","deleted"],"properties":{"errors":{"type":"array","description":"Errors during process","items":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsErrors"}},"deleted":{"type":"array","description":"List with successfully deleted items","items":{"type":"integer"}}}},"LearnSubscriptionrecordDeleteItemsErrors":{"required":["id","error"],"properties":{"id":{"type":"integer","description":"The ID of the item requested to process that gene rated an error"},"error":{"type":"string","description":"Details of the error, e.g. item does not exist..."}}},"LearnSubscriptionrecordDeleteItemsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordDeleteItemsLast","description":"Link to the last page"}}},"LearnSubscriptionrecordDeleteItemsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordDeleteItemsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordDeleteItemsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordDeleteItemsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordGetUsersResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordGetUsersData","description":"List of all retrieved subscription bundles"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordGetUsersLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordGetUsersData":{"required":["items","count","has_more_data","cursor","current_page","current_page_size"],"properties":{"items":{"$ref":"#/definitions/LearnSubscriptionrecordGetUsersItems","description":"Array of subscription bundles info objects"},"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 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/LearnSubscriptionrecordGetUsersSort"}}}},"LearnSubscriptionrecordGetUsersItems":{"required":["user_id","user_name","first_name","last_name","email"],"properties":{"user_id":{"type":"integer","description":"User ID"},"user_name":{"type":"string","description":"User name"},"first_name":{"type":"string","description":"First name of an user"},"last_name":{"type":"string","description":"last name of an user"},"email":{"type":"string","description":"Email of an user"}}},"LearnSubscriptionrecordGetUsersSort":{"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"}}},"LearnSubscriptionrecordGetUsersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordGetUsersSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordGetUsersGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordGetUsersFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordGetUsersLast","description":"Link to the last page"}}},"LearnSubscriptionrecordGetUsersSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordGetUsersGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordGetUsersFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordGetUsersLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordTerminateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordTerminateData","description":"ID of the updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordTerminateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordTerminateData":{"required":["terminated_record_id"],"properties":{"terminated_record_id":{"type":"integer","description":"The internal ID for the terminated Subscription record"}}},"LearnSubscriptionrecordTerminateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordTerminateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordTerminateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordTerminateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordTerminateLast","description":"Link to the last page"}}},"LearnSubscriptionrecordTerminateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordTerminateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordTerminateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordTerminateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordGetAssociatedUsersResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordGetAssociatedUsersData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordGetAssociatedUsersLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordGetAssociatedUsersData":{"properties":{"items":{"type":"array","description":"List of Users","items":{"$ref":"#/definitions/LearnSubscriptionrecordGetAssociatedUsersItems"}},"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/LearnSubscriptionrecordGetAssociatedUsersSort"}}},"required":["count","has_more_data","current_page","current_page_size"]},"LearnSubscriptionrecordGetAssociatedUsersItems":{"required":["user_id","username","firs_tname","last_name","email"],"properties":{"user_id":{"type":"integer","description":"The ID of the user"},"username":{"type":"string","description":"Username of the user"},"firs_tname":{"type":"string","description":"First name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"email":{"type":"string","description":"Email of the user"}}},"LearnSubscriptionrecordGetAssociatedUsersSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnSubscriptionrecordGetAssociatedUsersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordGetAssociatedUsersSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordGetAssociatedUsersGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordGetAssociatedUsersFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordGetAssociatedUsersLast","description":"Link to the last page"}}},"LearnSubscriptionrecordGetAssociatedUsersSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordGetAssociatedUsersGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordGetAssociatedUsersFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordGetAssociatedUsersLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordUnassociateUsersSchema":{"type":"object","required":["user_ids"],"properties":{"user_ids":{"type":"array","description":"IDs of user to be unassociated","items":{"type":"integer"}},"select_all":{"description":"Select all user: 0 no, 1 - yes","enum":["0","1"],"type":"integer"}}},"LearnSubscriptionrecordUnassociateUsersResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordUnassociateUsersData","description":"Response success or failure to find users"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordUnassociateUsersLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordUnassociateUsersData":{"required":["unassigned_user_ids"],"properties":{"unassigned_user_ids":{"type":"array","description":"List of unassigned user IDs","items":{"type":"integer"}}}},"LearnSubscriptionrecordUnassociateUsersLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordUnassociateUsersSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordUnassociateUsersGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordUnassociateUsersFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordUnassociateUsersLast","description":"Link to the last page"}}},"LearnSubscriptionrecordUnassociateUsersSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordUnassociateUsersGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordUnassociateUsersFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordUnassociateUsersLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Subscription records to be added","items":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItems"}}}},"LearnSubscriptionrecordBatchItems":{"required":["bundle_code","plan_code","code","item_code","item_type","start_date","end_date"],"properties":{"bundle_code":{"type":"string","description":"Subscription bundle code"},"plan_code":{"type":"string","description":"Subscription plan code"},"code":{"type":"string","description":"Subscription record code"},"item_code":{"type":"string","description":"Item code"},"item_type":{"description":"Type of the item","enum":["user","branch","group"],"type":"string"},"include_descendants":{"type":"boolean","description":"Optional only valid if item_type='branch'"},"start_date":{"type":"string","description":"Starting date"},"end_date":{"type":"string","description":"End date"},"status":{"description":"Status of the item, by default 'active'","enum":["active","inactive"],"type":"string"},"notes":{"type":"string","description":"Subscription record notes"},"use_items_from_bundle":{"type":"boolean","description":"Copy the bundle items to the record items"},"plan_fields":{"$ref":"#/definitions/LearnSubscriptionrecordBatchPlanFields","description":"Object of field_id and value pairs to populate additional fields defined for the plan. Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."},"bundle_fields":{"$ref":"#/definitions/LearnSubscriptionrecordBatchBundleFields","description":"Object of field_id and value pairs to populate additional fields defined for the bundle. Key is 'field_xxx' where 'xxx' is the ID of the additional field, the value is an additional field value."}}},"LearnSubscriptionrecordBatchPlanFields":{},"LearnSubscriptionrecordBatchBundleFields":{},"LearnSubscriptionrecordBatchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordBatchData","description":"Array containing the result status"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordBatchData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Whether or not the operation was successful"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnSubscriptionrecordBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordBatchLast","description":"Link to the last page"}}},"LearnSubscriptionrecordBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordBatchItemsL2Schema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Subscription records to be added","items":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsItems"}}}},"LearnSubscriptionrecordBatchItemsItems":{"required":["record_code","catalog_code"],"properties":{"record_code":{"type":"string","description":"Subscription record code"},"catalog_code":{"type":"string","description":"Subscription catalog code"}}},"LearnSubscriptionrecordBatchItemsL2Response":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordBatchItemsData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Whether or not the operation was successful"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnSubscriptionrecordBatchItemsLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordBatchItemsLast","description":"Link to the last page"}}},"LearnSubscriptionrecordBatchItemsSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordBatchItemsGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordBatchItemsFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordBatchItemsLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionrecordGetResourcesResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionrecordGetResourcesData","description":"List of all retrieved Courses/Learning Plans"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionrecordGetResourcesLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionrecordGetResourcesData":{"properties":{"items":{"type":"array","description":"Array of subscription records info objects","items":{"$ref":"#/definitions/LearnSubscriptionrecordGetResourcesItems"}},"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. Can be null"},"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/LearnSubscriptionrecordGetResourcesSort"}}},"required":["count","has_more_data","cursor","current_page","current_page_size"]},"LearnSubscriptionrecordGetResourcesItems":{"required":["item_id","item_type","item_code","item_name","item_description"],"properties":{"item_id":{"type":"integer","description":"ID of a Course or Learning plan"},"item_type":{"type":"string","description":"Item type (Course or Learning plan)"},"item_code":{"type":"string","description":"Item code"},"item_name":{"type":"string","description":"Item name"},"item_description":{"type":"string","description":"Item description"}}},"LearnSubscriptionrecordGetResourcesSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["name","code","description"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnSubscriptionrecordGetResourcesLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionrecordGetResourcesSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionrecordGetResourcesGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionrecordGetResourcesFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionrecordGetResourcesLast","description":"Link to the last page"}}},"LearnSubscriptionrecordGetResourcesSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionrecordGetResourcesGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionrecordGetResourcesFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionrecordGetResourcesLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionseatassociationCreateSchema":{"type":"object","required":["record_id","item_ids"],"properties":{"record_id":{"type":"integer","description":"ID of the subscription record"},"item_ids":{"type":"array","description":"IDs of the user item_ids = user_ids, IDs of the branch = branch_ids or IDs of the group = group_ids.","items":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateItemIds"}},"branch_ids":{"type":"array","description":"IDs of the branches","items":{"type":"integer"}},"group_ids":{"type":"array","description":"IDs of the groups","items":{"type":"integer"}},"seat_end_date":{"type":"string","format":"date","description":"Date when the seat expires. It will be by default the end of the subscription record it refers to. Date format - yyyy-MM-dd HH:mm:ss"}}},"LearnSubscriptionseatassociationCreateItemIds":{},"LearnSubscriptionseatassociationCreateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateData","description":"ID of new record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionseatassociationCreateData":{"required":["created_ids"],"properties":{"created_ids":{"type":"array","description":"Array of created sub_seat_association ids.","items":{"type":"integer"}},"errors":{"type":"array","description":"List of errors.","items":{"type":"string"}},"warnings":{"type":"array","description":"List of warnings","items":{"type":"string"}}}},"LearnSubscriptionseatassociationCreateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateLast","description":"Link to the last page"}}},"LearnSubscriptionseatassociationCreateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionseatassociationCreateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionseatassociationCreateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionseatassociationCreateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionseatassociationCreateMultipleSchema":{"type":"object","required":["record_ids","user_id"],"properties":{"record_ids":{"type":"array","description":"IDs of the subscription records","items":{"type":"string"}},"user_id":{"type":"integer","description":"ID of the user to be associated."}}},"LearnSubscriptionseatassociationCreateMultipleResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateMultipleData","description":"ID of new record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateMultipleLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionseatassociationCreateMultipleData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Status of the operation"}}},"LearnSubscriptionseatassociationCreateMultipleLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateMultipleSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateMultipleGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateMultipleFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionseatassociationCreateMultipleLast","description":"Link to the last page"}}},"LearnSubscriptionseatassociationCreateMultipleSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionseatassociationCreateMultipleGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionseatassociationCreateMultipleFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionseatassociationCreateMultipleLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionseatassociationDeleteSchema":{"type":"object","required":["record_id","item_ids"],"properties":{"record_id":{"type":"integer","description":"ID of the subscription record"},"item_ids":{"type":"array","description":"IDs of the user item_ids = user_ids, IDs of the branch = branch_ids or IDs of the group = group_ids.","items":{"type":"integer"}}}},"LearnSubscriptionseatassociationDeleteResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionseatassociationDeleteData","description":"ID of new record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionseatassociationDeleteLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionseatassociationDeleteData":{"required":["assigned_ids"],"properties":{"assigned_ids":{"type":"array","description":"Array of un- assigned sub_seat_association ids.","items":{"type":"integer"}},"errors":{"type":"array","description":"List of errors.","items":{"type":"string"}}}},"LearnSubscriptionseatassociationDeleteLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionseatassociationDeleteSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionseatassociationDeleteGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionseatassociationDeleteFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionseatassociationDeleteLast","description":"Link to the last page"}}},"LearnSubscriptionseatassociationDeleteSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionseatassociationDeleteGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionseatassociationDeleteFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionseatassociationDeleteLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionseatassociationIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionseatassociationIndexData","description":"List of all retrieved subscription seat associations"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionseatassociationIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionseatassociationIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of subscription seat associations info objects","items":{"$ref":"#/definitions/LearnSubscriptionseatassociationIndexItems"}},"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/LearnSubscriptionseatassociationIndexSort"}}}},"LearnSubscriptionseatassociationIndexItems":{"required":["id","user_id","record_id","record_name","mode","status","seat_end_date","assignment_date"],"properties":{"id":{"type":"integer","description":"Subscription seat association ID"},"user_id":{"type":"integer","description":"Subscription seat association user ID"},"record_id":{"type":"integer","description":"Subscription seat association record ID"},"record_name":{"type":"string","description":"Subscription seat association record name"},"mode":{"type":"integer","description":"Subscription seat association mode"},"status":{"type":"integer","description":"Subscription seat association status"},"seat_end_date":{"type":"string","format":"date","description":"Subscription seat association seat end date"},"assignment_date":{"type":"string","format":"date","description":"Subscription seat association seat assignment date"}}},"LearnSubscriptionseatassociationIndexSort":{"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"}}},"LearnSubscriptionseatassociationIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionseatassociationIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionseatassociationIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionseatassociationIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionseatassociationIndexLast","description":"Link to the last page"}}},"LearnSubscriptionseatassociationIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionseatassociationIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionseatassociationIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionseatassociationIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionseatassociationUpdateSchema":{"type":"object","properties":{"status":{"description":"Specifies the current status of the seat. Can get the following values: 1: "in_use", 2: "expired", 3: "cancelled". Default - current value","enum":["1","2","3"],"type":"integer"},"seat_end_date":{"type":"string","description":"Date when the seat expires. It will be by default the end of the subscription record it refers to. Date format - yyyy-MM-dd HH:mm:ss. Default - current value"}}},"LearnSubscriptionseatassociationUpdateResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionseatassociationUpdateData","description":"ID of updated record"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionseatassociationUpdateLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionseatassociationUpdateData":{"required":["updated_id"],"properties":{"updated_id":{"type":"integer","description":"Updated record ID"}}},"LearnSubscriptionseatassociationUpdateLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionseatassociationUpdateSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionseatassociationUpdateGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionseatassociationUpdateFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionseatassociationUpdateLast","description":"Link to the last page"}}},"LearnSubscriptionseatassociationUpdateSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionseatassociationUpdateGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionseatassociationUpdateFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionseatassociationUpdateLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionseatassociationViewResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionseatassociationViewData","description":"Return subscription seat association object"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionseatassociationViewLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionseatassociationViewData":{"required":["id","user_id","assignment_date","mode","status","seat_end_date","record_id","record_id","record_name","record_plan_id","record_type","record_notes","record_availability","record_start_date","record_end_date","record_status","price"],"properties":{"id":{"type":"integer","description":"Subscription seat association ID"},"user_id":{"type":"integer","description":"Subscription seat association user ID"},"assignment_date":{"type":"string","format":"date","description":"Subscription seat association seat assignment date"},"mode":{"type":"integer","description":"Subscription seat association mode"},"status":{"type":"integer","description":"Subscription seat association status"},"seat_end_date":{"type":"string","format":"date","description":"Subscription seat association seat end date"},"record_id":{"type":"integer","description":"Subscription seat association record ID"},"record_name":{"type":"string","description":"Subscription seat association record name"},"record_plan_id":{"type":"integer","description":"Subscription seat association record plan ID"},"record_type":{"type":"integer","description":"Subscription seat association record type"},"record_notes":{"type":"string","description":"Subscription seat association record notes"},"record_availability":{"type":"integer","description":"Subscription seat association record availability"},"record_start_date":{"type":"string","format":"date","description":"Subscription seat association record start date"},"record_end_date":{"type":"string","format":"date","description":"Subscription seat association record end date"},"record_status":{"type":"integer","description":"Subscription seat association record status"},"price":{"type":"number","format":"float","description":"Subscription seat association record price"}}},"LearnSubscriptionseatassociationViewLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionseatassociationViewSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionseatassociationViewGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionseatassociationViewFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionseatassociationViewLast","description":"Link to the last page"}}},"LearnSubscriptionseatassociationViewSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionseatassociationViewGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionseatassociationViewFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionseatassociationViewLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionseatassociationListSeatsByUserResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSubscriptionseatassociationListSeatsByUserData","description":"List of all retrieved subscription seat associations"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionseatassociationListSeatsByUserLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionseatassociationListSeatsByUserData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"Array of subscription seat associations info objects","items":{"$ref":"#/definitions/LearnSubscriptionseatassociationListSeatsByUserItems"}},"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/LearnSubscriptionseatassociationListSeatsByUserSort"}}}},"LearnSubscriptionseatassociationListSeatsByUserItems":{"required":["id","user_id","record_id","record_name","mode","status","seat_end_date","assignment_date"],"properties":{"id":{"type":"integer","description":"Subscription seat association ID"},"user_id":{"type":"integer","description":"Subscription seat association user ID"},"record_id":{"type":"integer","description":"Subscription seat association record ID"},"record_name":{"type":"string","description":"Subscription seat association record name"},"mode":{"type":"integer","description":"Subscription seat association mode"},"status":{"type":"integer","description":"Subscription seat association status"},"seat_end_date":{"type":"string","format":"date","description":"Subscription seat association seat end date"},"assignment_date":{"type":"string","format":"date","description":"Subscription seat association seat assignment date"}}},"LearnSubscriptionseatassociationListSeatsByUserSort":{"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"}}},"LearnSubscriptionseatassociationListSeatsByUserLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionseatassociationListSeatsByUserSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionseatassociationListSeatsByUserGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionseatassociationListSeatsByUserFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionseatassociationListSeatsByUserLast","description":"Link to the last page"}}},"LearnSubscriptionseatassociationListSeatsByUserSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionseatassociationListSeatsByUserGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionseatassociationListSeatsByUserFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionseatassociationListSeatsByUserLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSubscriptionseatassociationBatchSchema":{"type":"object","required":["items"],"properties":{"items":{"type":"array","description":"Subscription records to be added","items":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchItems"}}}},"LearnSubscriptionseatassociationBatchItems":{"required":["record_code","username","assignment_expiration"],"properties":{"record_code":{"type":"string","description":"Subscription record code"},"username":{"type":"string","description":"Username"},"assignment_date":{"type":"string","description":"Assignment date"},"assignment_expiration":{"type":"string","description":"Assignment expiration"}}},"LearnSubscriptionseatassociationBatchResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"Array containing the result status","items":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSubscriptionseatassociationBatchData":{"required":["success"],"properties":{"success":{"type":"boolean","description":"Whether or not the operation was successful"},"message":{"type":"string","description":"Message in case of failure"}}},"LearnSubscriptionseatassociationBatchLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSubscriptionseatassociationBatchLast","description":"Link to the last page"}}},"LearnSubscriptionseatassociationBatchSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSubscriptionseatassociationBatchGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSubscriptionseatassociationBatchFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSubscriptionseatassociationBatchLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnSurveySurveyanswerResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnSurveySurveyanswerData","description":"List of all retrieved user answers"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnSurveySurveyanswerLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnSurveySurveyanswerData":{"required":["questions","answers"],"properties":{"questions":{"type":"array","description":"Object containing the list of the survey questions indexed by the id of the question","items":{"$ref":"#/definitions/LearnSurveySurveyanswerQuestions"}},"answers":{"type":"array","description":"The list of the answers divided by compilation (No user info returned)","items":{"$ref":"#/definitions/LearnSurveySurveyanswerAnswers"}}}},"LearnSurveySurveyanswerQuestions":{"required":["id_quest","type_quest","title_quest"],"properties":{"id_quest":{"type":"integer","description":"The id of the question"},"type_quest":{"type":"string","description":"The type of question"},"title_quest":{"type":"array","description":"A string with the title of the question except for linker scale question where we have a list with the answers indexed by the id of the answer","items":{"$ref":"#/definitions/LearnSurveySurveyanswerTitleQuest"}}}},"LearnSurveySurveyanswerTitleQuest":{"properties":{"id_answer":{"type":"string","description":"The title of the answer"}}},"LearnSurveySurveyanswerAnswers":{"properties":{"answers":{"$ref":"#/definitions/LearnSurveySurveyanswerAnswersL2","description":"The list of answer of a compilation of the survey indexed by the id of the question"},"total_records":{"type":"integer","description":"The total number of records"},"total_pages":{"type":"integer","description":"The total number of pages"},"page":{"type":"integer","description":"The current page returned"},"page_size":{"type":"integer","description":"The number of element returned"}},"required":["total_records","total_pages","page","page_size"]},"LearnSurveySurveyanswerAnswersL2":{},"LearnSurveySurveyanswerLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnSurveySurveyanswerSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnSurveySurveyanswerGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnSurveySurveyanswerFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnSurveySurveyanswerLast","description":"Link to the last page"}}},"LearnSurveySurveyanswerSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnSurveySurveyanswerGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnSurveySurveyanswerFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnSurveySurveyanswerLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnTestsIndexResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnTestsIndexData","description":"API response"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnTestsIndexLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnTestsIndexData":{"required":["items","count","has_more_data","current_page","current_page_size"],"properties":{"items":{"type":"array","description":"List of test LO's","items":{"$ref":"#/definitions/LearnTestsIndexItems"}},"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/LearnTestsIndexSort"}}}},"LearnTestsIndexItems":{"required":["id","title","course","id_user","fullname"],"properties":{"id":{"type":"integer","description":"Internal ID of the test LO"},"title":{"type":"string","description":"Name of the test LO"},"course":{"$ref":"#/definitions/LearnTestsIndexCourse","description":"Course Data"},"id_user":{"type":"integer","description":"ID of the user who submitted the test"},"fullname":{"type":"string","description":"Full name (or username, if names are not provided) of the user waiting to be evaluated"}}},"LearnTestsIndexCourse":{"required":["name","id_course","course_type"],"properties":{"name":{"type":"string","description":"Name of the course, that contains test"},"id_course":{"type":"integer","description":"Internal ID of the course"},"course_type":{"type":"string","description":"Type of course"}}},"LearnTestsIndexSort":{"required":["sort_attr","sort_dir"],"properties":{"sort_attr":{"description":"Sorting field name","enum":["code","name","type","is_public"],"type":"string"},"sort_dir":{"description":"Sorting direction: asc = ascending, desc = descending","enum":["asc","desc"],"type":"string"}}},"LearnTestsIndexLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnTestsIndexSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnTestsIndexGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnTestsIndexFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnTestsIndexLast","description":"Link to the last page"}}},"LearnTestsIndexSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnTestsIndexGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnTestsIndexFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnTestsIndexLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarCreateWebinarAccountSchema":{"type":"object","required":["name","tool","app_key","app_secret","session_type"],"properties":{"name":{"type":"string","description":"The account name"},"tool":{"type":"string","description":"The tool name (zoomv2meeting, gotomeeting..)"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""}}},"LearnWebinarCreateWebinarAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarCreateWebinarAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarCreateWebinarAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarCreateWebinarAccountData":{"required":["id","name","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"max_sessions":{"type":"integer","description":""}}},"LearnWebinarCreateWebinarAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarCreateWebinarAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarCreateWebinarAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarCreateWebinarAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarCreateWebinarAccountLast","description":"Link to the last page"}}},"LearnWebinarCreateWebinarAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarCreateWebinarAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarCreateWebinarAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarCreateWebinarAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarListWebinarAccountResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarListWebinarAccountData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnWebinarListWebinarAccountData":{"required":["items","page","total_count","total_page_count"],"properties":{"items":{"type":"array","description":"The list of accounts","items":{"$ref":"#/definitions/LearnWebinarListWebinarAccountItems"}},"page":{"type":"integer","description":"Number of the page to read. Default value: 1"},"total_count":{"type":"integer","description":"Total number of accounts"},"total_page_count":{"type":"integer","description":"Total number of current page"}}},"LearnWebinarListWebinarAccountItems":{"required":["id","app_key","app_secret","name","description","paired","created_at"],"properties":{"id":{"type":"integer","description":"The account id"},"app_key":{"type":"string","description":"The app key associated with the account"},"app_secret":{"type":"string","description":"The app secret associated with the account"},"app_site":{"type":"string","description":"The app site associated with the account (related and required for webex accounts)"},"name":{"type":"string","description":"The account name"},"description":{"type":"string","description":"The account description"},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"paired":{"type":"boolean","description":"If true means the account is paired with provider"},"created_at":{"type":"string","description":"The account creation date"}}},"LearnWebinarUpdateWebinarAccountSchema":{"type":"object","required":["id","name","tool","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"tool":{"type":"string","description":"The tool name (zoomv2meeting, gotomeeting..)"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""}}},"LearnWebinarUpdateWebinarAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarUpdateWebinarAccountData":{"required":["id","name","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"max_sessions":{"type":"integer","description":""}}},"LearnWebinarUpdateWebinarAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAccountLast","description":"Link to the last page"}}},"LearnWebinarUpdateWebinarAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarUpdateWebinarAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarUpdateWebinarAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarUpdateWebinarAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarPairWebinarAccountSchema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"The authorization code"}}},"LearnWebinarPairWebinarAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarPairWebinarAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarPairWebinarAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarPairWebinarAccountData":{},"LearnWebinarPairWebinarAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarPairWebinarAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarPairWebinarAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarPairWebinarAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarPairWebinarAccountLast","description":"Link to the last page"}}},"LearnWebinarPairWebinarAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarPairWebinarAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarPairWebinarAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarPairWebinarAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarDeleteWebinarAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response. Empty array","items":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAccountData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarDeleteWebinarAccountData":{},"LearnWebinarDeleteWebinarAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAccountLast","description":"Link to the last page"}}},"LearnWebinarDeleteWebinarAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarDeleteWebinarAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarDeleteWebinarAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarDeleteWebinarAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarCreateWebinarAdobeconnectAccountSchema":{"type":"object","required":["name","tool","admin_username","admin_password","session_type","server_url"],"properties":{"name":{"type":"string","description":"The account name"},"tool":{"type":"string","description":"The tool name (zoomv2meeting, gotomeeting..)"},"additional_info":{"type":"string","description":"Just a description"},"admin_username":{"type":"string","description":""},"admin_password":{"type":"string","description":""},"session_type":{"type":"string","description":""},"server_url":{"type":"string","description":""},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""}}},"LearnWebinarCreateWebinarAdobeconnectAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarCreateWebinarAdobeconnectAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarCreateWebinarAdobeconnectAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarCreateWebinarAdobeconnectAccountData":{"required":["id","name","admin_username","admin_password","server_url"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"additional_info":{"type":"string","description":"Just a description"},"admin_username":{"type":"string","description":""},"admin_password":{"type":"string","description":""},"server_url":{"type":"string","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"max_sessions":{"type":"integer","description":""}}},"LearnWebinarCreateWebinarAdobeconnectAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarCreateWebinarAdobeconnectAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarCreateWebinarAdobeconnectAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarCreateWebinarAdobeconnectAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarCreateWebinarAdobeconnectAccountLast","description":"Link to the last page"}}},"LearnWebinarCreateWebinarAdobeconnectAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarCreateWebinarAdobeconnectAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarCreateWebinarAdobeconnectAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarCreateWebinarAdobeconnectAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarUpdateWebinarAdobeconnectAccountSchema":{"type":"object","required":["id","name","tool","admin_username","admin_password","server_url"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"tool":{"type":"string","description":"The tool name (zoomv2meeting, gotomeeting..)"},"additional_info":{"type":"string","description":"Just a description"},"admin_username":{"type":"string","description":""},"admin_password":{"type":"string","description":""},"server_url":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""}}},"LearnWebinarUpdateWebinarAdobeconnectAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAdobeconnectAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAdobeconnectAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarUpdateWebinarAdobeconnectAccountData":{"required":["id","name","admin_username","admin_password","server_url"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"additional_info":{"type":"string","description":"Just a description"},"admin_username":{"type":"string","description":""},"admin_password":{"type":"string","description":""},"server_url":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"max_sessions":{"type":"integer","description":""}}},"LearnWebinarUpdateWebinarAdobeconnectAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAdobeconnectAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAdobeconnectAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAdobeconnectAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarUpdateWebinarAdobeconnectAccountLast","description":"Link to the last page"}}},"LearnWebinarUpdateWebinarAdobeconnectAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarUpdateWebinarAdobeconnectAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarUpdateWebinarAdobeconnectAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarUpdateWebinarAdobeconnectAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarListWebinarAdobeconnectAccountResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarListWebinarAdobeconnectAccountData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnWebinarListWebinarAdobeconnectAccountData":{"required":["items","page","total_count","total_page_count"],"properties":{"items":{"type":"array","description":"The list of accounts","items":{"$ref":"#/definitions/LearnWebinarListWebinarAdobeconnectAccountItems"}},"page":{"type":"integer","description":"Number of the page to read. Default value: 1"},"total_count":{"type":"integer","description":"Total number of accounts"},"total_page_count":{"type":"integer","description":"Total number of current page"}}},"LearnWebinarListWebinarAdobeconnectAccountItems":{"required":["id","admin_username","admin_password","server_url","name","description","paired","created_at"],"properties":{"id":{"type":"integer","description":"The account id"},"admin_username":{"type":"string","description":"The username associated with the account"},"admin_password":{"type":"string","description":"The password associated with the account"},"server_url":{"type":"string","description":"The server url associated with the account"},"name":{"type":"string","description":"The account name"},"description":{"type":"string","description":"The account description"},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"paired":{"type":"boolean","description":"If true means the account is paired with provider"},"created_at":{"type":"string","description":"The account creation date"}}},"LearnWebinarDeleteWebinarAdobeconnectAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response. Empty array","items":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAdobeconnectAccountData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAdobeconnectAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarDeleteWebinarAdobeconnectAccountData":{},"LearnWebinarDeleteWebinarAdobeconnectAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAdobeconnectAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAdobeconnectAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAdobeconnectAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarDeleteWebinarAdobeconnectAccountLast","description":"Link to the last page"}}},"LearnWebinarDeleteWebinarAdobeconnectAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarDeleteWebinarAdobeconnectAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarDeleteWebinarAdobeconnectAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarDeleteWebinarAdobeconnectAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarCreateWebinarGotomeetingAccountSchema":{"type":"object","required":["name","tool","app_key","app_secret","session_type"],"properties":{"name":{"type":"string","description":"The account name"},"tool":{"type":"string","description":"The tool name (zoomv2meeting, gotomeeting..)"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""}}},"LearnWebinarCreateWebinarGotomeetingAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarCreateWebinarGotomeetingAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarCreateWebinarGotomeetingAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarCreateWebinarGotomeetingAccountData":{"required":["id","name","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"max_sessions":{"type":"integer","description":""}}},"LearnWebinarCreateWebinarGotomeetingAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarCreateWebinarGotomeetingAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarCreateWebinarGotomeetingAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarCreateWebinarGotomeetingAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarCreateWebinarGotomeetingAccountLast","description":"Link to the last page"}}},"LearnWebinarCreateWebinarGotomeetingAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarCreateWebinarGotomeetingAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarCreateWebinarGotomeetingAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarCreateWebinarGotomeetingAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarUpdateWebinarGotomeetingAccountSchema":{"type":"object","required":["id","name","tool","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"tool":{"type":"string","description":"The tool name (zoomv2meeting, gotomeeting..)"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""}}},"LearnWebinarUpdateWebinarGotomeetingAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarUpdateWebinarGotomeetingAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarUpdateWebinarGotomeetingAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarUpdateWebinarGotomeetingAccountData":{"required":["id","name","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"max_sessions":{"type":"integer","description":""}}},"LearnWebinarUpdateWebinarGotomeetingAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarUpdateWebinarGotomeetingAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarUpdateWebinarGotomeetingAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarUpdateWebinarGotomeetingAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarUpdateWebinarGotomeetingAccountLast","description":"Link to the last page"}}},"LearnWebinarUpdateWebinarGotomeetingAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarUpdateWebinarGotomeetingAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarUpdateWebinarGotomeetingAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarUpdateWebinarGotomeetingAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarListWebinarGotomeetingAccountResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarListWebinarGotomeetingAccountData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnWebinarListWebinarGotomeetingAccountData":{"required":["items","page","total_count","total_page_count"],"properties":{"items":{"type":"array","description":"The list of accounts","items":{"$ref":"#/definitions/LearnWebinarListWebinarGotomeetingAccountItems"}},"page":{"type":"integer","description":"Number of the page to read. Default value: 1"},"total_count":{"type":"integer","description":"Total number of accounts"},"total_page_count":{"type":"integer","description":"Total number of current page"}}},"LearnWebinarListWebinarGotomeetingAccountItems":{"required":["id","app_key","app_secret","name","description","paired","created_at"],"properties":{"id":{"type":"integer","description":"The account id"},"app_key":{"type":"string","description":"The app key associated with the account"},"app_secret":{"type":"string","description":"The app secret associated with the account"},"app_site":{"type":"string","description":"The app site associated with the account (related and required for webex accounts)"},"name":{"type":"string","description":"The account name"},"description":{"type":"string","description":"The account description"},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"paired":{"type":"boolean","description":"If true means the account is paired with provider"},"created_at":{"type":"string","description":"The account creation date"}}},"LearnWebinarDeleteWebinarGotomeetingAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response. Empty array","items":{"$ref":"#/definitions/LearnWebinarDeleteWebinarGotomeetingAccountData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarDeleteWebinarGotomeetingAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarDeleteWebinarGotomeetingAccountData":{},"LearnWebinarDeleteWebinarGotomeetingAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarDeleteWebinarGotomeetingAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarDeleteWebinarGotomeetingAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarDeleteWebinarGotomeetingAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarDeleteWebinarGotomeetingAccountLast","description":"Link to the last page"}}},"LearnWebinarDeleteWebinarGotomeetingAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarDeleteWebinarGotomeetingAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarDeleteWebinarGotomeetingAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarDeleteWebinarGotomeetingAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarPairGotomeetingWebinarAccountSchema":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"The authorization code"}}},"LearnWebinarPairGotomeetingWebinarAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarPairGotomeetingWebinarAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarPairGotomeetingWebinarAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarPairGotomeetingWebinarAccountData":{},"LearnWebinarPairGotomeetingWebinarAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarPairGotomeetingWebinarAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarPairGotomeetingWebinarAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarPairGotomeetingWebinarAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarPairGotomeetingWebinarAccountLast","description":"Link to the last page"}}},"LearnWebinarPairGotomeetingWebinarAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarPairGotomeetingWebinarAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarPairGotomeetingWebinarAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarPairGotomeetingWebinarAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarCreateWebinarMsteamsAccountSchema":{"type":"object","required":["name","tool","client_id","client_secret","session_type","tenant_id"],"properties":{"name":{"type":"string","description":"The account name"},"tool":{"type":"string","description":"The tool name (zoomv2meeting, gotomeeting..)"},"additional_info":{"type":"string","description":"Just a description"},"client_id":{"type":"string","description":""},"client_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"is_calendarmeeting":{"type":"boolean","description":""},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"tenant_id":{"type":"string","description":""}}},"LearnWebinarCreateWebinarMsteamsAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarCreateWebinarMsteamsAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarCreateWebinarMsteamsAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarCreateWebinarMsteamsAccountData":{"required":["id","name","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"max_sessions":{"type":"integer","description":""}}},"LearnWebinarCreateWebinarMsteamsAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarCreateWebinarMsteamsAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarCreateWebinarMsteamsAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarCreateWebinarMsteamsAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarCreateWebinarMsteamsAccountLast","description":"Link to the last page"}}},"LearnWebinarCreateWebinarMsteamsAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarCreateWebinarMsteamsAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarCreateWebinarMsteamsAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarCreateWebinarMsteamsAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarUpdateWebinarMsteamsAccountSchema":{"type":"object","required":["id","name","tool","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"tool":{"type":"string","description":"The tool name (zoomv2meeting, gotomeeting..)"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""}}},"LearnWebinarUpdateWebinarMsteamsAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarUpdateWebinarMsteamsAccountData","description":"Contains simple "success" flag indicating that the operation was a success"},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarUpdateWebinarMsteamsAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarUpdateWebinarMsteamsAccountData":{"required":["id","name","app_key","app_secret","session_type"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"additional_info":{"type":"string","description":"Just a description"},"app_key":{"type":"string","description":""},"app_secret":{"type":"string","description":""},"session_type":{"type":"string","description":""},"email":{"type":"string","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"max_sessions":{"type":"integer","description":""}}},"LearnWebinarUpdateWebinarMsteamsAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarUpdateWebinarMsteamsAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarUpdateWebinarMsteamsAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarUpdateWebinarMsteamsAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarUpdateWebinarMsteamsAccountLast","description":"Link to the last page"}}},"LearnWebinarUpdateWebinarMsteamsAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarUpdateWebinarMsteamsAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarUpdateWebinarMsteamsAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarUpdateWebinarMsteamsAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarListWebinarMsteamsAccountResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarListWebinarMsteamsAccountData","description":"Response result"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnWebinarListWebinarMsteamsAccountData":{"required":["items","page","total_count","total_page_count"],"properties":{"items":{"type":"array","description":"The list of accounts","items":{"$ref":"#/definitions/LearnWebinarListWebinarMsteamsAccountItems"}},"page":{"type":"integer","description":"Number of the page to read. Default value: 1"},"total_count":{"type":"integer","description":"Total number of accounts"},"total_page_count":{"type":"integer","description":"Total number of current page"}}},"LearnWebinarListWebinarMsteamsAccountItems":{"required":["id","app_key","app_secret","name","description","paired","created_at"],"properties":{"id":{"type":"integer","description":"The account id"},"app_key":{"type":"string","description":"The app key associated with the account"},"app_secret":{"type":"string","description":"The app secret associated with the account"},"app_site":{"type":"string","description":"The app site associated with the account (related and required for webex accounts)"},"name":{"type":"string","description":"The account name"},"description":{"type":"string","description":"The account description"},"max_sessions":{"type":"integer","description":""},"max_sessions_per_course":{"type":"integer","description":""},"max_concurrent_sessions":{"type":"integer","description":""},"paired":{"type":"boolean","description":"If true means the account is paired with provider"},"created_at":{"type":"string","description":"The account creation date"}}},"LearnWebinarDeleteWebinarMsteamsAccountResponse":{"required":["data","version","version","version","_links","version"],"properties":{"data":{"type":"array","description":"API response. Empty array","items":{"$ref":"#/definitions/LearnWebinarDeleteWebinarMsteamsAccountData"}},"version":{"type":"string","required":"required","description":"Current API version"},"_links":{"$ref":"#/definitions/LearnWebinarDeleteWebinarMsteamsAccountLinks","description":"Links to related resources. See https://en.wikipedia.org/wiki/HATEOAS"}}},"LearnWebinarDeleteWebinarMsteamsAccountData":{},"LearnWebinarDeleteWebinarMsteamsAccountLinks":{"required":["self","goto","first","last"],"properties":{"self":{"$ref":"#/definitions/LearnWebinarDeleteWebinarMsteamsAccountSelf","description":"Link to the current page"},"goto":{"$ref":"#/definitions/LearnWebinarDeleteWebinarMsteamsAccountGoto","description":"Go to a specified page number"},"first":{"$ref":"#/definitions/LearnWebinarDeleteWebinarMsteamsAccountFirst","description":"Link to the first page"},"last":{"$ref":"#/definitions/LearnWebinarDeleteWebinarMsteamsAccountLast","description":"Link to the last page"}}},"LearnWebinarDeleteWebinarMsteamsAccountSelf":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the current page"}}},"LearnWebinarDeleteWebinarMsteamsAccountGoto":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the specific page"}}},"LearnWebinarDeleteWebinarMsteamsAccountFirst":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the first page"}}},"LearnWebinarDeleteWebinarMsteamsAccountLast":{"required":["href"],"properties":{"href":{"type":"string","description":"Url of the last page"}}},"LearnWebinarViewWebinarMsteamsAccountResponse":{"required":["data","version"],"properties":{"data":{"$ref":"#/definitions/LearnWebinarViewWebinarMsteamsAccountData","description":"Response object"},"version":{"type":"string","required":"required","description":"Current API version"}}},"LearnWebinarViewWebinarMsteamsAccountData":{"required":["id","name","client_id","client_secret","tenant_id","description","tool","session_type","created_at","is_calendarmeeting","paired"],"properties":{"id":{"type":"integer","description":"The account id"},"name":{"type":"string","description":"The account name"},"client_id":{"type":"string","description":"The Client ID associated with the account"},"client_secret":{"type":"string","description":"The Client secret associated with the account"},"tenant_id":{"type":"string","description":"The Tenant ID associated with the account"},"description":{"type":"string","description":"The description account"},"tool":{"description":"","enum":["msteamsv2meeting","msteamsv2event"],"type":"string"},"session_type":{"description":"","enum":["msteamsv2meeting","msteamsv2event"],"type":"string"},"max_sessions":{"type":"integer","description":"Max rooms per account"},"max_concurrent_sessions":{"type":"integer","description":"Max concurrent rooms"},"max_sessions_per_course":{"type":"integer","description":"Max rooms per course"},"created_at":{"type":"string","description":"Date of post creation"},"is_calendarmeeting":{"type":"boolean","description":""},"paired":{"type":"boolean","description":"If true means the account is paired with provider"}}}}}