Courses and Terms can be created, updated, and deleted using CSV Imports.
The fields requested for the update are identical to those requested for create, with the exception of needing the Course or Term ID for making updates.
Generating a Course or Term Export will provide much of the data you need for a Create or Update-action import. You may also need to generate an Organization or Department export to obtain the system IDs for those objects.
IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As cited below, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
Removing or Appending Field Values on update
Since you can copy existing values from an export into an update-action import file, we expect that if you wish to retain the existing values, those will be resident in the import. This means that for updates:
- To REMOVE the value(s) for a field where the value is optional, remove the existing value and leave the field blank.
- If the value is required and the field is blank, the row will be rejected.
- If the value is optional and the field is blank, the value will be removed from the object's properties.
- If the value is optional and the field is missing (the column is not resident) from the import, that value will be removed from ALL of the items in the update.
- To REPLACE the value for a field, remove the existing value and replace it with the new/updated value.
- To APPEND the values in a field where multiple values are allowed, retain the existing values but add the new values into the field (separating with a semi-colon.
Create Course
Download a sample CSV file and enter the values for your new courses into the fields provided. Then import your new file.
You can use either the ID or the Name to identify the Organization and/or Department to which a course belongs (both are optional). To use the system ID, perform a Department Export to get that information first and copy it into the appropriate fields of your import file.
Field Name | Description | Example |
---|---|---|
Course Code (required) | Identifier for the course; must be unique within the institution. | ENG-300 |
Course Name (required) | Descriptive name for the course | Advanced Literature |
Organization ID (optional) | System ID of the organization to which this course belongs | 38151b-015-4de-8cc-f98d91 |
Department ID (optional) | System ID of the department to which this course belongs | 56924a-315-4de-8dg-f98d91 |
External Id (optional) | External system identifier of the course | Determined by the external system |
Update Course
Generate a Course Export, then select and update the necessary information for the import file. Then import your new file.
IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As cited above, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
Field Name | Description | Example |
---|---|---|
Course ID (required) | System ID of the course being updated | 69324a-315-4de-8dg-g75d42 |
Course Code (required) | Identifier for the course; must be unique within the institution. | ENG-300 |
Course Name (required) | Descriptive name for the course | Advanced Literature |
Organization ID (optional) | System ID of the organization to which this course belongs | 38151b-015-4de-8cc-f98d91 |
Department ID (optional) | System ID of the department to which this course belongs | 56924a-315-4de-8dg-f98d91 |
External Id (optional) | External system identifier of the course | Determined by the external system |
Create Term
Download a sample CSV file and enter the necessary data into the fields (columns) provided. Then import your new file.
Field Name | Description | Example |
---|---|---|
Term name (required) | The name of the term | Fall 2017 |
Start (required) | Start date (first day) of the term. Format: yyyy-mm-dd | 2017-08-25 |
End (required) | End date (last day) of the term. Format: yyyy-mm-dd | 2017-12-10 |
Exceptions (optional) | One or more dates on which classes will not take place. Captures scheduled for a section will not occur on these dates. Separate multiple date values with semicolons |
2017-09-01;2017-10-12;2017-11-22;2017-11-23;2017-11-24;2017-11-25;2017-11-26 |
External Id (optional) | External system identifier of the term | Determined by the external system |
Update Term
Generate a Term Export, then select and update the necessary information for the import file. Then import your new file.
IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As cited above, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
Field Name | Description | Example | |
---|---|---|---|
Term ID (required) | System ID of the term being updated | 69324a-315-4de-8dg-g75d42 | |
Term name (required) | The name of the term | Fall 2017 | |
Start (optional) | Start date (first day) of the term. Format: yyyy-mm-dd | 2017-08-25 | |
End (optional) | End date (last day) of the term. Format: yyyy-mm-dd | 2017-12-10 | |
Exceptions (optional) | One or more dates on which classes will not take place. Captures scheduled for a section will not occur on these dates. Separate individual date values with semicolons |
2017-09-01;2017-10-12;2017-11-22;2017-11-23;2017-11-24;2017-11-25;2017-11-26 | |
External Id (optional) | External system identifier of the term | Determined by the external system |