...
shortname: The shortname for the course
fullname: The full name for the course
idnumber: The ID number for the course
category: The ID of the category to place the course in. This takes precedence over category_idnumber and category_path.
category_idnumber: The ID number of the category to place the course in. This takes precedence over category_path.
category_path: The path of the category to place the course in. If you want to place the course in a category named "Clinical" which is located under the category "Classroom", the value to provide is: Classroom / Clinical. Note that the separator must be [space]/[space]. Also note that the category MUST exist, it will not be created. If you want to place the course in the top-level category "Clinical", the value to provide is: Clinical
visible: Use the value 1 if the course is visible, 0 if hidden
startdate: The time at which the course starts. The format should be DD.MM.YYYY. For example, to set a start time of December 1st 2014, use 01.12.2014
summary: The summary of the course
format: The course format to use, this must be a valid course format plugin name. The existing valid values are "topics", "weeks", "singleactivity" and "grid"
showgrades: Use the value 1 to show the gradebook to students, 0 to hide it.
showreports: Use the value 1 to show the activity reports, 0 to hide it.
maxbytes: The maximum upload size of the course in bytes. Use 0 for the site limit.
groupmode: Use the value 0 for No groups, 1 for Separate groups and 2 for Visible groups.
groupmodeforce: Use the value 1 to force the group mode, otherwise enter 0.
enablecompletion: Use the value 1 to enable the activity completion, 0 not to.
sitecertificate: Used to specify the name of the certificate of completion to attach to the course.
expiration: Specifies whether or not the learning record generated by the course will expire. The valid values are “never”, “time” and “date”.
Never means the learning record will never expire
Time means the learning record will expire after a certain amount of time (in days, months or years)
Date means the learning record will expire at a specific date as defined by “expiration_date”
expiration_time_unit: Specifies the unit when “expiration_type” is set to “time”. The valid values are “day”, “month” and “year” (all singular).
expiration_time_number: Specify the number of units (as per “expiration_time_unit”). Must be a positive integer.
For example, if you wanted the learning record to expire 1 year after it was issued, you would set the following:
expiration_type = time
expiration_unit = year
expiration_number = 1
expiration_time_round_up: Specifies, when expiration = time, whether to round up the expiration date to the last day of the month. The valid values are 0 (do not round up) and 1 (round up).
For example, a user completes a course for the first time on March 15, 2024. The learning record for the course is set to expire every 365 days. If expiration_time_round_up is set to 0, then the expiration date for the learning record will be March 15, 2025. If expiration_time_round_up is set to 1, then the expiration date for the learning record will be March 31, 2025 because March 31st is the last day of the month of March.
expiration_date_month: The month that the learning record issued by the course will expire. This valid values are from 1 to 12, where 1 is January, 2 is February, etc.
expiration_date_day: The day that the learning record issued by the course will expire. The valid values are from 1 to 31 (depending on the month in question).
expiration_date_frequency: How frequently (in years) the learning record will expire when expiration = date. The valid values are from 1 to 10, where one means “every year”, 2 means “every 2 years”, etc.
recertification: Specifies whether or not the user can get recertify (e.g. get another learning record after already having received one). The valid values are “anytime”, “never” and “specific”.
Anytime means the user can get recertified anytime they want
Never means that the user can never get recertified (unless an administrator intervenes and or expires their previous learning records for the course in question)
Specific means that means that you will define a specific recertification window / timeframe using the “recertification_unit” and “recertification_value” fields
recertification_unit: Specifies the unit when “recertification” is set to “specific”. The valid values are “day”, “month” and “year” (all singular).
recertification_number: Specify the number of units (as per “recertification_unit”). Must be a positive integer.
For example, if you wanted the users to be able to start the recertification process 90 days before their next due date for the course, you would set the following:
recertification = specific
recertification_unit = day
recertification_number = 90
recertification_ontime: Specifies, when the user completes the course on time (e.g. before or on their due date), if the expiration date newly issued learning record (when a user gets recertified) will be based on the date the user completes the course, or the date of the previous learning record. The valid values are “completion” and “expiration”.
For example, let’s assume a user needs to complete the “First Aid” every 2 years. They completed it in early 2022 and their due date is currently March 31st, 2024. The user completes “First Aid” on February 15, 2024. If “recertification_ontime” is set to “completion”, the next due date for the user in question will be “February 15, 2026”. However if “recertification_ontime” is set to “expiration”, their next due date will be March 31st 2026 (to maintain the original due date of March 31st from two years earlier).
recertification_overdue: Specifies, when a user completes the course late (e.g. missed their due date), if the expiration date newly issued learning record (when a user gets recertified) will be based on the date the user completes the course, or the date of the previous learning record. The valid values are “completion” and “expiration”.
For example, let’s assume a user needs to complete the “First Aid” every 2 years. They completed it in early 2022 and their due date is currently March 31st, 2024. The user completes “First Aid” on April 15, 2024. If “recertification_overdue” is set to “completion”, the next due date for the user in question will be “April 15, 2026”. However if “recertification_overdue” is set to “expiration”, their next due date will be March 31st 2026 (to maintain the original due date of March 31st from two years earlier).
...