Organizations and Departments 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 Org or Dept ID for making updates.
Generating an Organization or Department Export should provide all the data you need for an Update-action or Delete-action import.
A Delete-action import requires only the system ID for the Organizations or Departments you want to delete.
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 Organization
Download a sample CSV file and enter the necessary data into the fields (columns) provided. Then import your new file.
Field Name | Description | Example |
---|---|---|
Organization Name (required) | The name of the organization. Must be unique to the institution | Language Arts |
External Id (optional) | External system identifier of the organization | Determined by the external system |
Update Organization
Generate an Organization Export, then select and update the necessary organizational information. 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 |
---|---|---|
Organization ID (required) | System ID of the organization being updated | 69324a-315-4de-8dg-g75d42 |
Organization Name (required) | The name of the organization. Must be unique to the institution | Language Arts |
External Id (optional) | External system identifier of the organization | Determined by the external system |
Delete Organization
Generate an Organization Export, then select and copy the rows for the organizations you want to delete into a new file for the Delete-action import. You can retain additional fields in the file; all except ID are ignored. Then import your new file.
Field Name | Description | Example |
---|---|---|
Organization ID (required) | System ID of the organization being deleted | 69324a-315-4de-8dg-g75d42 |
Create Department
Download a sample CSV file and enter the values for your new department into the fields provided. Then import your new file.
You can use either Organization ID or Organization Name to identify the organization(s) to which the new Departments belong. To use the system ID, perform an Organization Export to get that information first and copy it to your create-action file.
Field Name | Description | Example |
---|---|---|
Department Name (required) | The name of the department. Must be unique to the institution | English |
Organization Id (optional) | System ID of the organization to which the department is to belong. | 38151b-015-4de-8cc-f98d91 |
External Id (optional) | External system identifier of the department | Determined by the external system |
Update Department
Generate a Department 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 |
---|---|---|
Department ID (required) | System ID of the department being updated | 69324a-315-4de-8dg-g75d42 |
Department Name (required) | The name of the department. Must be unique to the institution | English |
Organization ID (optional) | System ID of the organization to which the department belongs. | 38151b-015-4de-8cc-f98d91 |
External Id (optional) | External system identifier of the department | Determined by the external system |
Delete Department
Generate a Department Export, then select and copy the rows for the departments you want to delete into a new file for the Delete-action import. You can retain additional fields in the file; all except ID are ignored. Then import your new file.
Field Name | Description | Example |
---|---|---|
Department ID (required) | System ID of the department being deleted | 69324a-315-4de-8dg-g75d42 |