Подсистема «Интеграция с внешними ЭЖ»
Данная подсистема представляет собой программный интерфейс для взаимодействия с внешними электронными журналами (далее – ЭЖ), используемыми образовательными организациями (далее – ОО) Красноярского края. Подсистема должна предоставлять интеграционный программный интерфейс (далее – API) для интеграции внешних информационных систем.
Подсистема интеграции обеспечивает передачу во внешние электронные журналы сведений из Краевой информационной автоматизированной системы управления образованием (далее – КИАСУО) о списочном составе сотрудников и обучающихся и движении учащихся для формирования в электронном журнале учебных классов. А также получение от электронных журналов сведений о ходе учебного процесса (расписание уроков с учетом замен, сведения о темах уроках, выданном домашнем задании, посещаемости занятий обучающимся и полученных им оценках) для возможности получения родителями (законными представителями) муниципальной услуги «Предоставление информации о текущей успеваемости учащегося, ведению электронного дневника и электронного журнала успеваемости» на Портале государственных услуг (далее – ПГУ), а также для передачи сведений о годовой успеваемости в Единую федеральную межведомственную систему учета контингента обучающихся по основным образовательным программам и дополнительным общеобразовательным программам (далее – Контингент).
Подсистема должна обеспечивать возможность обмена информацией в режиме реального времени для предоставления возможности получить актуальные сведения через ПГУ.
Передача данных между Системой и внешними ЭЖ осуществляется в виде стандартных HTTP-запросов. Перед началом передачи данных должна происходить авторизация внешней информационной системы на сервере Системы. Далее обмен данными между Системой и внешним ЭЖ должен осуществляться с использованием специального ключа сессии Системы.
Ключ должен быть уникальной строкой, генерируемой Системой для каждого уникального сеанса обмена данными, хранящийся в памяти сервера Системы. Ключ сессии должен:
- хранить информацию о текущем пользователе (внешней информационной системе, ID разработчика); хранить информацию об образовательной организации, информация по которой загружается или выгружается из системы (ID школы); ограничивать время неактивности текущего пользователя.
Для предоставления доступа к своим ресурсам образовательная организация сообщает разработчику свой ID в системе и ключ доступа. Ключ доступа совместно с ID разработчика используется для получения ключа сессии.
Обмен информацией с API осуществляется в формате XML (или JSON).
Через API внешние информационные системы должны получить возможность двухстороннего обмена следующими данными:
Функция | Входные данные | Выходные данные | Описание |
Получить список классов | ID учебного года | ID класса Параллель Литера Классный руководитель (ID сотрудника) | Отдает список классов образовательной организации в указанном учебном году |
Получить список сотрудников | ID сотрудника Фамилия Имя Отчество Пол Дата рождения | Отдает список сотрудников образовательной организации | |
Получить список обучающихся | ID учебного года | ID обучающегося Фамилия Имя Отчество Пол Дата рождения | Отдает список обучающихся образовательной организации в указанном учебном году |
Получить список приказов по движению учащихся | Дата ОТ Дата ДО | ID приказа ID обучающегося Дата приказа Номер приказа Тип приказа (зачисление / отчисление / перевод) Дата события ID школы (откуда) ID класса (откуда) ID школы (куда) ID класса (куда) | Отдает список приказов по движению обучающихся по образовательной организации за указанные даты. |
Получить список предметов | ID предмета Название Сокращенное название | Отдает список предметов образовательной организации, заведенных в Системе | |
Создать / изменить предмет | ID предмета (необязательный) Название Сокращенное название | ID предмета | Изменяет (в случае указания ID) или создает новый предмет в Системе |
Получить список учебных групп | ID учебного года | ID группы Название группы | Отдает список учебных групп образовательной организации |
Создать / изменить учебную группу | ID учебного года ID группы (необязательный) Название группы | ID группы | Создает новую (при указании ID) или изменяет существующую группу |
Получить список обучающихся группы | ID группы | ID обучающегося Массив периодов обучения в группе (Дата зачисления, Дата отчисления) | Отдает список обучающихся учебной группы с датами их зачисления и отчисления |
Передать сведения о зачислении / отчислении обучающихся в учебную группу | ID группы Дата зачисления Дата отчисления | Зачисляет и/или отчисляет обучающегося в/из учебную группу | |
Создать / изменить учебный план | ID учебного плана (необязательно) ID класса (необязательно) ID учебной группы (необязательно) ID предмета ID сотрудника | ID учебного плана | Создает/изменяет элемент учебного плана образовательной организации. При создании обязательно должен быть указан один из ID: класса или группы |
Создать / изменить расписание уроков | Дата расписания Сведения об уроках: [ ID учебного плана День недели Номер урока] | Создает / изменяет расписание уроков. Каждое расписание действует до его отмены следующим. Каждое загружаемое расписание содержит сведения обо всех своих элементах | |
Создать / изменить замену урока | ID учебного плана (по расписанию) Дата Номер урока ID учебного плана (по замене) (необязательный) | ID замены | Создает / изменяет замену урока. В случае, если не указан ID заменяемого учебного плана – отмена урока |
Удалить замену | ID замены | Отменяет внесенную ранее замену | |
Записать тему тему урока и домашнее задание | ID учебного плана Дата Номер урока Тема урока (необязательный) Домашнее задание (необязательный) | Записывает тему и домашнее задание на конкретный урок | |
Выставить оценку, отметку о присутствии, комментарий | ID учебного плана ID обучающегося Дата Номер урока Отметка о присутствии на уроке (необязательный) Полученные оценки (необязательный): [ Оценка Комментарий (необязательный)] | Отмечает факт присутствия учащегося на уроке, полученные оценки и комментарии к ним. При вызове метода всегда передается вся информация об учащемся, предыдущие сведения затираются. | |
Выставить оценку промежуточной / годовой / итоговой аттестации | ID учебного плана ID обучающегося Номер / тип аттестационного периода Оценка Комментарий (необязательный) | Выставляет оценку промежуточной / годовой / итоговой аттестации обучающегося |
