Instructors and assigned courses service
The API end URL structure that should be used to access instructors and assigned course data for course planning is as follows.
| Url | Method |
| https://[InstitutionName].aplancloud.com/api/integration/course-solution/instructors-info | Post |
Tablo 39. Instructors and Assigned Courses Service Url Structure
When retrieving data from any lesson planning solution, it is necessary to select which term and solution the data will be retrieved from in the Constructor Schedule system. For this purpose, the parameters that need to be added to the API Body are as follows. Mandatory fields are specified by adding the * character to the beginning of the “Parameter type” column value in the table.
The instructor, faculty and program codes filters are optional. If sent with an empty array, all data is sent without filtering. Since there is a pagination structure for the result, values can be entered for the “size” and “page” parameters.
| Parameter name | Parameter Type | Description |
| term_id | * integer | Term id |
| solution_id | * integer | Solution id |
| instructor_codes | string array | Instructor codes |
| faculty_codes | string array | Faculty codes |
| program_codes | string array | Program codes |
| size | integer | Pagination size. Default is 10. Maximum is 100. |
| page | integer | Page number for pagination. |
Table 40. Instructors and Assigned Courses Service Parameters
In response, depending on the selected filter, term information, solution information, instructor information and the data of the courses to which the instructors are assigned will be returned. The relevant values are in the following structure.
| Data Label | Description |
| termId | Term Id |
| termYear | Term year |
| termSemester | Term semester |
| termName | Term name |
| termDescription | Term description |
| slotMinutes | Minute equivalent of a single slot in the term planning |
| solutionId | Solution Id |
| solutionName | Solution name |
| filterPage | Filter page number |
| filterSize | Filter page size |
| totalPage | Maximum page number available for the selected filter |
| totalSize | Total number of records |
| instructors | Instructors data (see Table 42) |
Table 41. Instructors and Assigned Courses Data Type Fields
Instructors data:
| Data Label | Description |
| instructorCode | Instructor code |
| title | Title |
| name | Name surname |
| facultyOfDutyCode | Faculty of duty code |
| facultyOfDutyName | Faculty of duty name |
| programOfDutyCode | Program of duty code |
| programOfDutyName | Program of duty name |
| staffType | Staff type |
| totalSlots | Total workload (number of slots) |
| courses | Data of courses assigned to instructors (see Table 43) |
Table 42. Instructors Data Data Type Fields
Data of courses assigned to instructors:
| Veri Etiketi | Açıklama | ||
| day | Day | ||
| startHour | Start hour | ||
| endHour | End hour | ||
| activityNo | Activity no (Plan365) | ||
| courseOpenedId | Course opened id (Institution) | ||
| courseCode | Course code | ||
| courseName | Course name | ||
| campusCode | Campus code | ||
| campusName | Campus name | ||
| facultyCode | Faculty code | ||
| facultyName | Faculty name | ||
| programCode | Program code | ||
| programName | Program name | ||
| educationType | Education type | ||
| grade | Grade | ||
| section | Section (Plan365) | ||
| courseOpenedSection | Course opened id (Institution) | ||
| courseType | Course type | ||
| activityType | Activity type | ||
| instructorCode | Instructor code | ||
| instructorName | Instructor name | ||
| slots | Activity duration (slot count) | ||
| weeks | Week numbers of the course | ||
| buildingCode | Building code | ||
| buildingName | Building name | ||
| classroomCode | Classroom code | ||
| classroomName | Classroom name | ||
| lectureCapacity | Student capacity | ||
| studentCount | Student count |