содержание .. 1 2
Описание программных интерфейсов государственной информационной системы «Современная цифровая образовательная среда» (Версия 2.8.5) - часть 2
Параметр
Тип
Ограничение
Описание
Пример
employer_ogrn
string
ОГРН работодателя (для
6048749502928
целевого договора)
5.1.9.1.6. Объект сведений о приказе
Параметр
Тип
Ограничение
Описание
Пример
order_number
string
Номер приказа
1
order_date
date
yyyy-MM-dd
Дата приказа
2022-08-01
5.1.9.1.7. Объект сведений о студенческом билете
Параметр
Тип
Ограничение
Описание
Пример
number
string
Номер студенческого билета
1
start_date
date
yyyy-MM-dd
Дата
начала
действия
2023-08-11
студенческого билета
end_date
date
yyyy-MM-dd
Дата окончания действия
2023-08-11
студенческого билета
5.1.9.1.8. Объект сведений о зачетной книжке
Параметр
Тип
Ограничение
Описание
Пример
number
string
Номер зачетной книжки
1
date
date
yyyy-MM-dd
Дата выдачи зачетной книжки
2023-08-11
5.1.9.1.9. Объект детальной информации по движению
Параметр
Тип
Ограничение
Описание
Пример
reason
string
Справочник
Причина отчисления, причина
DED_GRADUATION
значений
выхода в академический отпуск,
(приведен после
причина продления
таблицы)
академического отпуска
start_date
date
yyyy-MM-dd
Дата начала академического
2022-08-01
отпуска
end_date
date
yyyy-MM-dd
Дата окончания академического
2023-08-01
отпуска
Справочник значений для поля «reason» делится на два блока:
значения для причин
отчисления (коды причин отчисления начинаются с DED_) и значения причин для
академического отпуска (коды причин академического отпуска начинаются с SAB_). Возможные
значения приведены ниже.
Причины отчисления:
DED_GRADUATION - Отчислить в связи с получением образования (завершением обучения);
DED_VOLUNTARILY - Отчисление по собственному желанию;
DED_HEALTH - Отчисление по состоянию здоровья;
DED_DEATH - Отчисление в связи со смертью;
DED_SOLDIER - Отчисление в связи с призывом на военную службу в ВС РФ;
DED_UNDERPERFORMANCE - Отчисление за академическую неуспеваемость;
DED_STUDIES_NEVER_STARTED - Отчисление как не приступившего к занятиям;
DED_TRANSFER_INSTITUTION - Отчисление в связи с переводом в другую образовательную
организацию;
DED_TRANSFER_FACULTY - Отчисление в связи с переводом (на другой факультет);
DED_CONTRACT_DISREGARD - Отчисление в связи с невыполнением условий договора;
100
DED_NON_PAYMENT - Отчисление в связи с неоплатой обучения;
DED_CONTRACT_AVOIDANCE - Отчисление в связи с расторжением договора на обучение
(по неуважительной причине);
DED_TRANSFER_FULL_TIME - Отчисление в связи с переводом на очное обучение;
DED_TRANSFER_PART_TIME - Отчисление в связи с переводом на очно-заочное отделение;
DED_TRANSFER_EXTRAMURAL - Отчисление в связи с переводом на заочное отделение;
DED_STUDIES_STOP_ATTEND - Отчисление в связи с прекращением посещения занятий;
DED_REGULATIONS_VIOLATION
- Отчисление за нарушение правил внутреннего
распорядка;
DED_SABBATICAL_ABSENCE - Отчисление как не вернувшегося из академического отпуска;
DED_STATE_EXAM_NON_ADMISSION - Отчисление как недопущенного к государственной
итоговой аттестации;
DED_STATE_EXAM_FAILED
- Отчисление как не прошедшего государственное
аттестационное испытание;
DED_ORGANIZATION_LIQUIDATION - Отчисление в связи с ликвидацией образовательной
организации;
DED_CRIME - Отчисление в связи с вступлением в силу обвинительного приговора суда за
совершение преступления.
Причины выхода в академический отпуск, причины продления академического отпуска:
SAB_STUDY_INABILITY - В связи с невозможностью освоения образовательной программы
высшего образования;
SAB_FAMILY - По семейным обстоятельствам;
SAB_CHILD_THREE - По уходу за ребенком до 3 лет;
SAB_CHILD_ONE_AND_HALF - По уходу за ребенком до 1,5 лет;
SAB_HEALTH - По медицинским показаниям;
SAB_SOLDIER - В связи с призывом на военную службу;
SAB_STUDY_SENT - Направить для обучения;
SAB_PREGNANCY - По беременности и родам;
SAB_OPERATIONAL_NEED - В связи с производственной необходимостью;
SAB_FINANCIAL - В связи с существенным ухудшением материального положения;
SAB_COMPETITION - В связи с участием в официальных всероссийских и международных
соревнованиях;
SAB_CALAMITY - В связи с происшедшим стихийным бедствием;
SAB_STARTUP - В связи с созданием университетского стартапа;
SAB_OTHER - Иная причина.
5.1.9.2. Получение сведений о движении контингента указанного студента или аспиранта
5.1.9.2.1. Запрос
Формат
GET
запроса
101
5.1.9.2.2. Параметры запроса
Параметр
Тип
Ограничение
Обязательное
Описание
Пример
filter
string
Да
Поиск студента
351103171507
или аспиранта
по ИНН или
СНИЛС
organization_id
string
Длина от 1
Нет
Идентификатор
2a0fc6e23c774
до 128
организации
4478ab6114add
556f3e
5.1.9.2.3. Ответы
Статус
Описание
200
JSON с данными о движении контингента студента или аспиранта
[
{
"id": "16bd0100-e07c-11ea-87d0-0242ac130003",
"external_id": "string",
"organization_id": "2a0fc6e23c7744478ab6114add556f3e",
"organization_title": "Московский государственный университет",
"name": "string",
"surname": "string",
"middle_name": "string",
"snils": "string",
"inn": "string",
"contingent_flows": [
{
"id": "16bd0100-e07c-11ea-87d0-0242ac130003",
"external_id": "string",
"student_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"organization_id": "string",
"contingent_flow": "string",
"flow_type": "string",
"date": "2023-08-11T16:09:53.587Z",
"educational_program_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"education_level": "string",
"study_start_date": "2023-08-11T16:09:53.587Z",
"study_end_date": "2023-08-11T16:09:53.587Z",
"form_fin": "string",
"education_form": "string",
"faculty": "string",
"details": "string",
"contract_details": {
"target_contract_number": "ДР-003-О",
"target_contract_date": "2023-08-11T16:09:53.587Z",
"customer_name": "ООО \"Академия\"",
"customer_inn": "1711468260",
"employer_name": "ООО \"Технологии\"",
"employer_inn": "2556432452"
},
"speciality_code": "string",
"speciality_name": "string",
"order_details": {
"reason": "По семейным обстоятельствам",
"order_number": "1",
"order_date": "2023-08-11T16:09:53.587Z"
102
Статус
Описание
},
"flow_details": {
"reason": "По семейным обстоятельствам"
},
"study_year": 0,
"type_fin": "FEDERAL",
"special_right": false,
"updated_date": "2023-08-11T16:09:53.587Z",
"student_card": {
"number": "1",
"start_date": "2023-08-11T16:09:53.587Z",
"end_date": "2023-08-11T16:09:53.587Z"
},
"gradebook": {
"number": "1",
"date": "2023-08-11T16:09:53.587Z"
}
}
]
}
]
400
bad request (bad parameters)
5.1.9.2.4. Результаты поиска активности студента или аспиранта
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор студента или
744a6544-5202-419d-
аспиранта в ГИС СЦОС
8749-2005e2dc005b
external_id
string
Идентификатор студента или
35f04722-fea5-434e-
аспиранта в ИС ООВО или
ba2c-21f213a92af5
ИС Организации
organization_id
string
Идентификатор ООВО
5f90a883-f9c7-43e6-
9b19-7a25f5c9b834
organization_title
string
Полное наименование
Московский
организации
государственный
университет
name
string
Имя студента или аспиранта
Юлия
surname
string
Фамилия студента или
Бажанова
аспиранта
middle_name
string
Отчество студента или
Ивановна
аспиранта
snils
string
СНИЛС
85961058348
inn
string
ИНН
728163957603
contingent_flows
JSON
Список активностей студента
Данные в формате
или аспиранта
JSON в соответствии
моделью объекта
движения контингента
103
5.1.10. Оценки
5.1.10.1. Получение списка оценок
5.1.10.1.1. Запрос
Формат запроса
GET
ne_id={discipline_id}&student_id={student_id}&study_plan_id={study_plan_id}
&external_id={external_id}&page={page}&from_date={from_date}&page_size={
page_size}
5.1.10.1.2. Параметры запроса
Все параметры не являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1 до 128
Идентификатор
d67038c7-fd0a-465d-
образовательной организации
83dc-8f1e933c2b8b
discipline_id
UUID
Идентификатор дисциплины
a6a63c2a-f840-438d-
в ГИС СЦОС
8cb5-49d63040ed20
student_id
UUID
Идентификатор студента
16bd0100-e07c-11ea-
в ГИС СЦОС
87d0-0242ac130003
study_plan_id
UUID
Идентификатор учебного
52387c27-e39d-42da-
плана в ГИС СЦОС
bb4c-5314e28b6670
external_id
string
Длина от 1 до 256
Идентификатор оценки в ИС
ee4b280e-f119-11ea-
ООВО или ИС Организации
b586-f079598c20bb
page
integer
Номер запрашиваемой
3
страницы
from_date
date
yyyy-MM-DD
Дата, начиная с которой будут
2022-09-21
отдаваться измененные
данные
page_size
integer
Количество элементов на
10
странице
5.1.10.1.3. Ответы
Статус
Описание
200
JSON со списком оценок
{
"page": 1,
"last_page": 3,
"results": [{
"id": "e73fc302-533c-453e-a371-99d4ed657318",
"external_id": "cf4d688f-ef7b-4ada-b5f5-f92a16e79a1b"
"discipline": {
"id": "a6a63c2a-f840-438d-8cb5-49d63040ed20",
"external_id": "a3398d2a-9304-485c-8626-e1d9fffae881",
"title": "Высшая математика",
"type": "DISCIPLINE",
"updated_date": "2022-10-02",
"created_date": "2022-10-02"
},
"student": {
"id": "16bd0100-e07c-11ea-87d0-0242ac130003",
"surname": "Иванов",
104
Статус
Описание
"name": "Иван",
"middle_name": "Степанович",
"date_of_birth": "2002-01-01",
"snils": "126-037-041 42",
"inn": "502805064133",
"email": "iivanov@testmail.ru",
"phone": "8 (812) 480-00-00",
"citizenship": "RUS",
"date": "2022-10-26T12:53:57.690Z"
},
"study_plan": {
"id": "738e9f33-f892-4f3a-b4b7-4d835a2a54dc",
"title": "Мат. 2022 поток 1",
"start_year": "2022-01-01",
"end_year": "2026-01-01",
"direction": "Математика и компьютерные науки",
"code_direction": "07.00.00",
"education_form": "EXTRAMURAL",
"educational_program_id": "3fa85f64-5717-4562-b3fc-
2c963f66afa6",
"credits": 100,
"hours": 500,
"base": true,
"period_type": "семестр",
"period_count": 8,
"updated_date": "2022-10-02"
},
"mark_type": "EXAM",
"value": 4,
"semester": 2,
"normal_mark_value": GOOD,
"date": "2022-10-02",
"teacher": "Иванов И. С.",
"teacher_id": "e58d8034-89cb-4725-8372-28ffabf50756",
"reset": false,
"details": {},
"updated_date": "2022-11-01"
}]
}
400
bad request (bad parameters)
5.1.10.1.4. Результат поиска оценок
Название
Тип
Ограничение
Обязательное
Описание
Пример
page
integer
Да
Номер страницы
1
last_page
integer
Да
Номер последней
3
страницы
results
JSON
Нет
Список оценок
Данные в формате
JSON в соответствии
моделью объекта
оценки
105
5.1.10.2. Получение оценки
5.1.10.2.1. Запрос
Формат запроса
GET
5.1.10.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор оценки в ГИС
d67038c7-fd0a-465d-83dc-
СЦОС
8f1e933c2b8b
5.1.10.2.3. Ответы
Статус
Описание
200
JSON с данными оценки
{
"id": "e73fc302-533c-453e-a371-99d4ed657318",
"external_id": "cf4d688f-ef7b-4ada-b5f5-f92a16e79a1b" "e73fc302-533c-453e-
a371-99d4ed657318",
"discipline": {
"id": "a6a63c2a-f840-438d-8cb5-49d63040ed20",
"external_id": "a3398d2a-9304-485c-8626-e1d9fffae881",
"title": "Высшая математика",
"type": "DISCIPLINE",
"updated_date": "2022-10-02",
"created_date": "2022-10-02"
},
"student": {
"id": "16bd0100-e07c-11ea-87d0-0242ac130003",
"surname": "Иванов",
"name": "Иван",
"middle_name": "Степанович",
"snils": "126-037-041 42",
"date_of_birth": "2002-01-01",
"phone": "8 (812) 480-00-00",
"inn": "502805064133",
"email": "iivanov@testmail.ru",
"external_id": "string",
"study_year": 0,
"scos_id": "string",
"organization_id": "string",
"citizenship": "RUS",
"date": "2022-10-26T12:53:57.690Z",
"gender": "MALE"
},
"study_plan": {
"id": "738e9f33-f892-4f3a-b4b7-4d835a2a54dc",
"title": "Мат. 2022 поток 1",
"start_year": "2022-01-01",
"end_year": "2026-01-01",
"direction": "Математика и компьютерные науки",
"code_direction": "07.00.00",
"education_form": "EXTRAMURAL",
106
Статус
Описание
"educational_program_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"credits": 100,
"hours": 500,
"base": true,
"period_type": "семестр",
"period_count": 8,
"updated_date": "2022-10-02"
},
"mark_type": "EXAM",
"value": 4,
"semester": 2,
"normal_mark_value": GOOD,
"date": "2022-10-02",
"teacher": "Иванов И. С.",
"teacher_id": "e58d8034-89cb-4725-8372-28ffabf50756",
"reset": false,
"details": {},
"updated_date": "2022-11-01"
}
400
bad request (bad parameters|id not found)
5.1.10.2.4. Объект оценки
Обязательн
Название
Тип
Ограничение
Описание
Пример
ое
id
UUID
Да
Идентификатор
d8c1b997-f1cd-4e96-
учебного плана в ГИС
8485-3b9c51ed2ebc
СЦОС
external_id
string
Длина от 1 до 256
Нет
Идентификатор оценки
cf4d688f-ef7b-4ada-
в ИС ООВО или ИС
b5f5-f92a16e79a1b
Организации
discipline
JSON
Да
Дисциплина
Данные в формате
JSON в
соответствии
моделью объекта
дисциплины
student
JSON
Да
Студент
Данные в формате
JSON в
соответствии
моделью объекта
студента
study_plan
JSON
Да
Учебный план
Данные в формате
JSON в
соответствии
моделью объекта
учебного плана
value
integer
Да
Оценка
4
107
Обязательн
Название
Тип
Ограничение
Описание
Пример
ое
mark_type
string
EXAM (MARK),
Да
Тип оценки:
EXAM
CREDIT,
EXAM, MARK -
DIF_CREDIT,
Экзамен,
COURSE_WORK,
CREDIT - зачет,
COURSE_PROJECT,
DIF_CREDIT -
HUNDRED_POINT
дифференцированный
зачет,
COURSE_WORK -
курсовая работа,
COURSE_PROJECT -
курсовой проект,
HUNDRED_POINT -
стобалльная оценка
normal_mark_
string
FAILED,
Нет
Значение оценки,
GOOD
value
PASSED,
приведенное к шкале
UNSATISFACTOR
ENUM:
Y,
FAILED - незачет,
SATISFACTORY,
PASSED - зачет,
GOOD,
UNSATISFACTORY -
EXCELLENT,
2 (неудовл.),
ABSENCE,
SATISFACTORY - 3
REASONABLE_AB
(удовлетворительно),
SENCE,
GOOD - 4 (хорошо),
NON_ADMISSION,
EXCELLENT - 5
RELEASE
(отлично),
ABSENCE - неявка,
REASONABLE_ABSE
NCE - неявка по
уважительной
причине,
NON_ADMISSION -
недопуск,
RELEASE -
освобождение
semester
integer
Да
Номер семестра
1
teacher
string
Длина от 1 до 256
Нет
Идентификатор
1be446a4-c047-
преподавателя,
4073-bf7b-
выставившего оценку в
8b320a2d9ff5
ИС ООВО или ИС
Организации
teacher_id
UUID
Нет
Идентификатор
b9773518-7302-
преподавателя,
4ed8-982e-
выставившего оценку в
df164b3f0541
ГИС СЦОС
date
date
yyyy-MM-DD
Нет
Дата выставления
2022-01-21
оценки
reset
boolean
Нет
Признак перезачета
false
details
JSON
Нет
Дополнительные
Данные в формате
сведения о практике,
JSON в
курсовой работе, ГИА
соответствии
моделью объекта
дополнительных
сведений о
практике, курсовой
работе, ГИА
updated_date
date
yyyy-MM-dd
Нет
Дата последнего
2022-01-02
обновления сущности
108
5.1.10.2.5. Объект дополнительных сведений о практике, курсовой работе, ГИА
Все параметры являются не обязательными
Параметр
Тип
Ограничение
Описание
Пример
company_name
string
Наименование предприятия, на
ОАО Тех
котором проходит практика
company_inn
string
ИНН предприятия
7535867927
company_ogrn
string
ОГРН предприятия
6048749502928
practice_start_date
date
yyyy-MM-dd
Дата начала практики
2022-06-01
practice_end_date
date
yyyy-MM-dd
Дата окончания практики
2022-07-05
comission_chairma
string
Имя председателя комиссии
Полина
n_name
comission_chairma
string
Фамилия председателя комиссии
Краснобаева
n_surname
comission_chairma
string
Отчество председателя
Германовна
n_middle_name
комиссии
comission_chairma
string
Должность председателя
Директор
n_position
комиссии
vkr_title
string
Тема ВКР
Повышение
эффективности
операций в цепях
поставок
scientific_director_
string
Имя научного руководителя
Егор
name
scientific_director_
string
Фамилия научного руководителя
Куксюк
surname
scientific_director_
string
Отчество научного руководителя
Тимофеевич
middle_name
commission_chair
string
Наименование организации, в
ОАО Тех
man_organization_t
которой работает председатель
itle
комиссии
commission_chair
string
ИНН организации, в которой
7535867927
man_organization_i
работает председатель комиссии
nn
course_work_title
string
Тема курсовой работы/проекта
Информационные
системы цифровой
экономики
5.1.11. Статистические данные об оценках по онлайн-курсам
5.1.11.1. Получение статистических данных об оценках по онлайн-курсам
5.1.11.1.1. Запрос
Формат запроса
GET
se_id={course_id}
5.1.11.1.2. Параметры запроса
Все параметры не являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1 до 128
Идентификатор образовательной
2a0fc6e23c7744478
организации
ab6114add556f3e
109
Параметр
Тип
Ограничение
Описание
Пример
course_id
string
Длина от 1 до 128
Идентификатор курса
02b137969fc24e37
ba8dbc233962317a
5.1.11.1.3. Ответы
Статус
Описание
200
JSON с данными дисциплины
{
"total": 9,
"edo_marks_count": 8,
"equals_marks_count": 4,
"not_equals_marks_count": 2,
"empty_marks_count": 3
}
400
bad request (bad parameters|id not found)
5.1.11.1.4. Объект статистики
Ограни
Обязате
Название
Тип
Описание
Пример
чение
льное
total
integer
Да
Общее количество контрактных
9
записей обучающихся
edo_marks_count
integer
Да
Количество оценок, полученных
8
на онлайн курсах
equals_marks_count
integer
Да
Количество оценок, принятых
4
к зачету, совпадающих с оценками,
полученными на онлайн курсах
not_equals_marks_count
integer
Да
Количество оценок, принятых к
2
зачету, не совпадающих с оценками,
полученными на онлайн курсах
empty_marks_count
integer
Да
Количество не принятых к зачету
2
оценок, полученных на онлайн
курсах
110
5.2. Интеграция образовательных организаций с ГИС СЦОС
Все POST методы пакетной загрузки данных:
- в случае отсутствия идентификатора сущности в запросе, либо отсутствия
идентификатора в системе, добавляют новые сущности;
- в случае, если сущность с заданным идентификатором будет найдена, она будет обновлена
в соответствии с передаваемыми в запросе данными.
5.2.1. Сотрудники профессорско-преподавательского состава
5.2.1.1. Загрузка сотрудников профессорско-преподавательского состава
5.2.1.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/teachers -d "json_body"
5.2.1.1.2. Параметры запроса
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки сотрудников
Данные в формате JSON
профессорско-преподавательского
в соответствии моделью объекта
состава
загрузки сотрудников профессорско-
преподавательского состава
5.2.1.1.3. Объект загрузки сотрудников профессорско-преподавательского состава
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1 до 128
Идентификатор
2a0fc6e23c7744478ab6
образовательной организации
114add556f3e
teachers
JSON
Список сотрудников
Данные в формате
профессорско-
JSON в соответствии
преподавательского состава
моделью объекта
сотрудника
5.2.1.1.4. Объект сотрудника профессорско-преподавательского состава
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
external_id
string
Длина от 1 до 128
Да
Идентификатор
32b1955e-0dda-
сотрудника ППС в
4557-9547-
ИС ООВО или ИС
97209404ca17
Организации
name
string
Длина от 1 до 128
Нет
Имя
Юлия
surname
string
Длина от 1 до 128
Нет
Фамилия
Бажанова
middle_name
string
Длина от 1 до 128
Нет
Отчество
Евгеньевна
citizenship
string
По справочнику
Нет
Гражданство по
RUS,BLR
ОКСМ в формате
справочнику ОКСМ
Альфа-3 или UDF,
в формате Альфа-3,
длина от 1 до 36
UDF - апатрид
snils
string
Валидное значение
Нет
СНИЛС
83201700446
СНИЛС
111
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
inn
string
Валидное значение
Нет
ИНН
275342757762
ИНН
email
string
Длина от 1 до 128
Нет
Адрес электронной
example@email.ru
почты
phone
string
Длина от 1 до 128
Нет
Номер телефона
9001234567
date_of_birth
date
yyyy-MM-dd
Нет
Дата рождения
1971-09-01
academic_degree
string
CANDIDATE,
Нет
Ученая степень:
DOCTOR
DOCTOR,
CANDIDATE -
PHD
кандидат наук
DOCTOR - доктор
наук,
PHD - PhD
academic_rank
string
DOCENT,
Нет
Ученое звание:
DOCENT
PROFESSOR
DOCENT - доцент,
PROFESSOR -
профессор
5.2.1.1.5. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
5.2.1.2. Обновление сотрудника профессорско-преподавательского состава
5.2.1.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/teachers/{id} -d "json_body"
5.2.1.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор сотрудника ППС
8e5bb17a-524d-4277-80d2-
в ГИС СЦОС
2478304758e2
json_body
JSON
Объект сотрудника профессорско-
Данные в формате JSON
преподавательского состава
в соответствии моделью объекта
сотрудника профессорско-
преподавательского состава
5.2.1.2.3. Объект сотрудника профессорско-преподавательского состава
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
organization_id
string
Длина от 1 до
Да
Идентификатор
2a0fc6e23c7744478
128
организации
ab6114add556f3e
external_id
string
Длина от 1 до
Да
Идентификатор
32b1955e-0dda-
128
сотрудника ППС в ИС
4557-9547-
ООВО или ИС
97209404ca17
Организации
112
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
name
string
Длина от 1 до
Нет
Имя
Юлия
128
surname
string
Длина от 1 до
Нет
Фамилия
Бажанова
128
middle_name
string
Длина от 1 до
Нет
Отчество
Евгеньевна
128
citizenship
string
По справочнику
Нет
Гражданство по
RUS,BLR
ОКСМ в
справочнику ОКСМ в
формате Альфа-
формате Альфа-3,
3 или UDF,
UDF - апатрид
длина от 1 до 36
snils
string
Валидное
Нет
СНИЛС
83201700446
значение
СНИЛС
inn
string
Валидное
Нет
ИНН
275342757762
значение ИНН
email
string
Длина от 1
Нет
Адрес электронной
example@email.ru
до 128
почты
phone
string
Длина от 1
Нет
Номер телефона
9001234567
до 128
date_of_birth
date
yyyy-MM-dd
Нет
Дата рождения
1971-09-01
academic_degree
string
CANDIDATE,
Нет
Ученая степень:
DOCTOR
DOCTOR,
CANDIDATE -
PHD
кандидат наук.
DOCTOR - доктор
наук,
PHD - PhD
academic_rank
string
DOCENT,
Нет
Ученое звание:
DOCENT
PROFESSOR
DOCENT - доцент,
PROFESSOR -
профессор
5.2.1.2.4. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.1.3. Удаление сотрудника профессорско-преподавательского состава
5.2.1.3.1. Запрос
Формат запроса
DELETE
5.2.1.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор сотрудника ППС в ГИС СЦОС
8e5bb17a-524d-4277-
80d2-2478304758e2
113
5.2.1.3.3. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
114
5.2.2. Статусы сотрудников профессорско-преподавательского состава
5.2.2.1. Загрузка статусов сотрудников профессорско-преподавательского состава
5.2.2.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/teachers_statuses -d "json_body"
5.2.2.1.2. Параметры запроса
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки статусов
Данные в формате JSON
сотрудников профессорско-
в соответствии моделью
преподавательского состава
объекта загрузки статусов
сотрудников
профессорско-
преподавательского
состава
5.2.2.1.3. Объект загрузки статусов сотрудников профессорско-преподавательского
состава
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1 до
Идентификатор
2a0fc6e23c7744478
128
образовательной
ab6114add556f3e
организации
(идентификатор платформы
СЦОС или ОГРН )
teachers_status
JSON
Список статусов
Данные в формате
сотрудников профессорско-
JSON в
преподавательского состава
соответствии
моделью объекта
статуса сотрудника
5.2.2.1.4. Объект статуса сотрудника профессорско-преподавательского состава
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
external_id
string
Длина от 1 до 128
Да
Идентификатор
d2631436-cfcf-4cd8-
статуса в ИС ООВО
af5b-94e2f0206c66
или ИС Организации
teacher
string
Длина от 1 до 128
Да
Идентификатор
e4c5fb9c-ecd1-4395-
сотрудника ППС в ИС
9d39-3279ce1f9922
ООВО или ИС
Организации
status
string
WORKING,
Да
Статус сотрудника
WORKING
DISMISSED,
ППС в рамках
ON_VACATION
договора:
WORKING -
работает,
ON_VACATION -
в отпуске,
DISMISSED - уволен
115
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
contract_exter
string
Длина от 1 до 128
Да
Идентификатор
ДР-005/1
nal_id
договора с
сотрудником ППС в
ИС ООВО или ИС
Организации
contract_detail
JSON
Нет
Условия договора
Данные в формате
s
JSON в соответствии
моделью объекта
условие договора
vacation_detai
JSON
Нет
Подробности учета
Данные в формате
ls
длительных отпусков
JSON в соответствии
(только для статуса
моделью объекта
«ON_VACATION»)
подробности учета
длительных
отпусков
status_date
date
yyyy-MM-dd
Да
Дата изменения
2022-08-01
статуса или его
сведений
dismissal_date
date
yyyy-MM-dd
Нет
Дата увольнения
2022-10-10
(только для статуса
«DISMISSED»)
5.2.2.1.5. Объект загрузки условия договора
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
work_start_date
date
yyyy-MM-dd
Да
Дата начала работы
2022-08-01
work_end_date
date
yyyy-MM-dd
Нет
Дата окончания работы
2023-07-01
position
string
ASSISTANT,
Да
Должность:
LECTURER
LECTURER,
ASSISTANT - ассистент,
SENIOR_LECTURER,
LECTURER - преподаватель,
DOCENT,
SENIOR_LECTURER -
PROFESSOR,
старший преподаватель,
DEPUTY,
DOCENT - доцент,
HOD,
PROFESSOR - профессор,
DEAN
DEPUTY - заместитель
заведующего кафедрой,
HOD - заведующий кафедрой,
DEAN - декан
position_name
string
Длина от 1 до 256
Нет
Наименование должности в
Преподавате
ИС ООВО или ИС
ль
Организации
rate
float
Нет
Ставка
1
department
string
Длина от 1 до 256
Нет
Название подразделения
Отдел
образования
employment_ty
string
FULL_TIME,
Да
Вид занятости:
PART_TIME
pe
PART_TIME_IN,
FULL_TIME - основное место
_IN
PART_TIME_OUT,
работы,
UNDEFINED
PART_TIME_IN - внутреннее
совместительство,
PART_TIME_OUT - внешнее
совместительство,
UNDEFINED - не
определено (указывать для
вида договора - ГПХ)
116
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
contract_type
string
LABOR,
Да
Вид договора:
LABOR
CIVIL
LABOR - трудовой договор,
CIVIL - ГПХ
5.2.2.1.6. Объект загрузки подробностей учета длительных отпусков
Все параметры являются необязательными
Параметр
Тип
Ограничение
Описание
Пример
start_date
date
yyyy-MM-dd
Дата начала отпуска
2023-06-01
end_date
date
yyyy-MM-dd
Дата окончания отпуска
2023-07-01
5.2.2.1.7.
5.2.2.1.7. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
5.2.2.2. Обновление статуса сотрудника профессорско-преподавательского состава
5.2.2.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/teachers_statuses/{id} -d "json_body"
5.2.2.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор статуса
8e5bb17a-524d-4277-
сотрудника ППС в ГИС
80d2-2478304758e2
СЦОС
json_body
JSON
Объект статуса сотрудника
Данные в формате JSON
профессорско-
в соответствии моделью
преподавательского состава
объекта статуса
сотрудника
профессорско-
преподавательского
состава
5.2.2.2.3. Объект статуса сотрудника профессорско-преподавательского состава
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
organization_id
string
Длина от 1
Да
Идентификатор
2a0fc6e23c7744478ab
до 128
образовательной
6114add556f3e
организации
external_id
string
Длина от 1
Да
Идентификатор статуса
d2631436-cfcf-4cd8-
до 128
в ИС ООВО или ИС
af5b-94e2f0206c66
Организации
117
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
status
string
WORKING,
Да
Статус сотрудника ППС
WORKING
DISMISSED,
в рамках договора:
ON_VACATION
WORKING - работает,
ON_VACATION -
в отпуске,
DISMISSED - уволен
contract_external_id
string
Длина от 1
Да
Идентификатор
ДР-005/1
до 128
договора с
сотрудником ППС в
ИС ООВО или ИС
Организации
contract_details
JSON
Нет
Условия договора
Данные в формате
JSON в соответствии
моделью объекта
условие договора
vacation_details
JSON
Нет
Подробности учета
Данные в формате
длительных отпусков
JSON в соответствии
(только для статуса
моделью объекта
«ON_VACATION»)
подробности учета
длительных отпусков
status_date
date
yyyy-MM-dd
Да
Дата изменения статуса
2022-08-01
или его сведений
dismissal_date
date
yyyy-MM-dd
Нет
Дата увольнения
2022-10-10
(только для статуса
«DISMISSED»)
5.2.2.2.4. Объект загрузки условия договора
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
work_start_date
date
yyyy-MM-dd
Дата начала работы
2022-08-01
work_end_date
date
yyyy-MM-dd
Дата окончания работы
2023-07-01
position
string
ASSISTANT,
Должность:
LECTURER
LECTURER,
ASSISTANT - ассистент,
SENIOR_LECTURER,
LECTURER - преподаватель,
DOCENT,
SENIOR_LECTURER -
PROFESSOR,
старший преподаватель,
DEPUTY,
DOCENT - доцент,
HOD,
PROFESSOR - профессор,
DEAN
DEPUTY - заместитель
заведующего кафедрой,
HOD - заведующий кафедрой,
DEAN - декан
position_name
string
Длина от 1 до 256
Наименование должности в
Преподаватель
ИС ООВО или ИС
Организации
rate
float
Ставка
1
department
string
Длина от 1 до 256
Название подразделения
Отдел
образования
118
Параметр
Тип
Ограничение
Описание
Пример
employment_type
string
FULL_TIME,
Вид занятости:
PART_TIME_IN
PART_TIME_IN,
FULL_TIME - основное место
PART_TIME_OUT,
работы,
UNDEFINED
PART_TIME_IN - внутреннее
совместительство,
PART_TIME_OUT - внешнее
совместительство,
UNDEFINED - не определено
(указывать для вида
договора - ГПХ)
contract_type
string
LABOR,
Вид договора:
LABOR
CIVIL
LABOR - трудовой договор,
CIVIL - ГПХ
5.2.2.2.5. Объект загрузки подробностей учета длительных отпусков
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
start_date
date
yyyy-MM-dd
Дата начала отпуска
2023-06-01
end_date
date
yyyy-MM-dd
Дата окончания отпуска
2023-07-01
5.2.2.2.6. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.2.3. Удаление статуса сотрудника профессорско-преподавательского состава
5.2.2.3.1. Запрос
Формат запроса
DELETE
5.2.2.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор статуса сотрудника ППС
8e5bb17a-524d-4277-80d2-
в ГИС СЦОС
2478304758e2
5.2.2.3.3. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
119
5.2.3. Образовательные программы
5.2.3.1. Загрузка образовательных программ
5.2.3.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/educational_programs -d "json_body"
5.2.3.1.2. Параметры запроса
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки
Данные в формате JSON
образовательных программ
в соответствии моделью
объекта загрузки
образовательных
программ
5.2.3.1.3. Объект загрузки образовательных программ
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1 до
Идентификатор
2a0fc6e23c7744478a
128
образовательной организации
b6114add556f3e
educational_programs
JSON
Список образовательных
Данные в формате
программ
JSON
в соответствии
моделью объекта
образовательной
программы
5.2.3.1.4. Объект образовательной программы
Ограниче
Обязат
Параметр
Тип
Описание
Пример
ние
ельное
external_id
string
Длина от 1
Да
Идентификатор
ee4b280e-f119-11ea-
до 256
образовательной программы
b586-f079598c20bb
в ИС ООВО или ИС
Организации
title
string
Длина от 1
Да
Название образовательной
Компьютерная
до 256
программы
безопасность
direction
string
Длина от 1
Да
Направление подготовки
Информатика и
до 256
вычислительная
техника
code_direction
string
Длина от 1
Нет
Код направления подготовки
09.03.01
до 20
start_year
integer
yyyy
Да
Год начала обучения
2022
end_year
integer
yyyy
Нет
Год окончания обучения
2026
5.2.3.1.5. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
120
5.2.3.2. Обновление образовательной программы
5.2.3.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/educational_programs/{id} -d "json_body"
5.2.3.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор образовательной
8e5bb17a-524d-4277-80d2-
программы в СЦОС в ГИС СЦОС
2478304758e2
json_body
JSON
Объект образовательной программы
Данные в формате JSON
в соответствии моделью объекта
образовательной программы
5.2.3.2.3. Объект образовательной программы
Ограниче
Обязат
Параметр
Тип
Описание
Пример
ние
ельное
organization_id
string
Длина от 1
Да
Идентификатор организации
2a0fc6e23c7744478a
до 128
b6114add556f3e
external_id
string
Длина от 1
Нет
Идентификатор
ee4b280e-f119-11ea-
до 256
образовательной программы
b586-f079598c20bb
в ИС ООВО или ИС
Организации
title
string
Длина от 1
Нет
Название образовательной
Компьютерная
до 256
программы
безопасность
direction
string
Длина от 1
Нет
Направление подготовки
Информатика и
до 256
вычислительная
техника
code_direction
string
Длина от 1
Нет
Код направления подготовки
09.03.01
до 20
start_year
integer
yyyy
Нет
Год начала обучения
2022
end_year
integer
yyyy
Нет
Год окончания обучения
2026
5.2.3.2.4. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.3.3. Удаление образовательной программы
5.2.3.3.1. Запрос
Формат запроса
DELETE
121
5.2.3.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор образовательной
8e5bb17a-524d-4277-
программы в ГИС СЦОС
80d2-2478304758e2
5.2.3.3.3. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
122
5.2.4. Учебные планы
5.2.4.1. Загрузка учебных планов
5.2.4.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/study_plans -d "json_body"
5.2.4.1.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки учебных
Данные в формате JSON
планов
в соответствии моделью
объекта загрузки учебных
планов
5.2.4.1.3. Объект загрузки учебных планов
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Идентификатор образовательной
2a0fc6e23c7744478ab6
организации
114add556f3e
study_plans
JSON
Список учебных планов
Данные в формате
JSON в соответствии
моделью объекта
учебного плана
5.2.4.1.4. Объект учебного плана
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
external_id
string
Длина от 1 до 128
Да
Идентификатор учебного
3d24f7a6-c801-
плана в ИС ООВО или
11e4-8a13-
ИС Организации
005056c00008
title
string
Длина от 1 до 256
Да
Название учебного плана
Рабочий план
00000002 от
01.06.2022 00:00:00
direction
string
Длина от 1 до 256
Да
Направление подготовки
Информатика и
вычислительная
техника
code_direction
string
Длина от 1 до 20
Нет
Код направления
09.03.01
подготовки
start_year
integer
yyyy
Да
Год начала обучения
2022
end_year
integer
yyyy
Да
Год окончания обучения
2026
123
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
education_form
string
FULL_TIME,
Да
Форма обучения:
EXTRAMURAL
PART_TIME,
FULL_TIME - очная;
EXTRAMURAL,
PART_TIME - очно-
SHORT_FULL_TIME,
заочная;
SHORT_PART_TIME,
EXTRAMURAL -
SHORT_EXTRAMURAL,
заочная;
EXTERNAL,
SHORT_FULL_TIME -
UNDEFINED
сокращенная очная;
SHORT_PART_TIME -
сокращенная очно-
заочная;
SHORT_EXTRAMURAL
- сокращенная заочная;
EXTERNAL - экстернат;
UNDEFINED -
не определена
educational_prog
string
Длина от 1 до 256
Да
Идентификатор
ee4b280e-f119-
ram
образовательной
11ea-b586-
программы в ИС ООВО
f079598c20bb
или ИС Организации
credits
integer
Нет
Количество зачетных
100
единиц
hours
integer
Нет
Количество аудиторных
500
часов
base
boolean
Нет
Признак базового
true
учебного плана
period_type
string
Длина от 1 до 32
Нет
Тип периодов обучения
семестр
period_count
integer
Нет
Количество периодов
8
обучения
period_details
JSON
Нет
Список сведений о
Данные в формате
периодах обучения
JSON в
соответствии
моделью объекта
сведений о периоде
обучения
5.2.4.1.5. Объект сведений о периоде обучения
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
number
integer
Да
Номер
1
start_date
date
yyyy-MM-DD
Нет
Дата начала
2022-08-02
end_date
date
yyyy-MM-DD
Нет
Дата окончания
2022-12-10
5.2.4.1.6. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
5.2.4.2. Обновление учебного плана
5.2.4.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/study_plans/{id} -d "json_body"
124
5.2.4.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор учебного
48ce075d-8fae-4939-9c5a-
плана в ГИС СЦОС
6436497dcd86
json_body
JSON
Объект учебного плана
Данные в формате JSON
в соответствии моделью объекта
учебного плана
5.2.4.2.3. Объект учебного плана
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
organization_id
string
Длина от 1 до 128
Да
Идентификатор
2a0fc6e23c7744478
организации
ab6114add556f3e
external_id
string
Длина от 1 до 256
Нет
Идентификатор
3d24f7a6-c801-
учебного плана в ИС
11e4-8a13-
ООВО или ИС
005056c00008
Организации
title
string
Длина от 1 до 256
Да
Название учебного
Рабочий план
плана
00000002 от
01.06.2022 00:00:00
direction
string
Длина от 1 до 256
Да
Направление
Информатика и
подготовки
вычислительная
техника
code_direction
string
Длина от 1 до 20
Нет
Код направления
09.03.01
подготовки
start_year
integer
yyyy
Да
Год начала обучения
2022
end_year
integer
yyyy
Да
Год окончания
2026
обучения
education_form
string
FULL_TIME,
Да
Форма обучения:
EXTRAMURAL
PART_TIME,
FULL_TIME - очная;
EXTRAMURAL,
PART_TIME - очно-
SHORT_FULL_TIME,
заочная;
SHORT_PART_TIME,
EXTRAMURAL -
SHORT_EXTRAMURAL,
заочная;
EXTERNAL,
SHORT_FULL_TIME -
UNDEFINED
сокращенная очная;
SHORT_PART_TIME -
сокращенная очно-
заочная;
SHORT_EXTRAMURA
L - сокращенная
заочная;
EXTERNAL -
экстернат;
UNDEFINED -
не определена
educational_prog
string
Длина от 1 до 256
Нет
Идентификатор
ee4b280e-f119-11ea-
ram
образовательной
b586-f079598c20bb
программы в ИС ООВО
или ИС Организации
credits
integer
Нет
Количество зачетных
100
единиц
hours
integer
Нет
Количество аудиторных
500
часов
125
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
base
boolean
Нет
Признак базового
true
учебного плана
period_type
string
Длина от 1 до 32
Нет
Тип периодов обучения
семестр
period_count
integer
Нет
Количество периодов
8
обучения
period_details
JSON
Нет
Список сведений о
Данные в формате
периодах обучения
JSON в
соответствии
моделью объекта
сведений о периоде
обучения
5.2.4.2.4. Объект сведений о периоде обучения
Параметр
Тип
Ограничение
Обязательное
Описание
Пример
number
integer
Да
Номер
1
start_date
date
yyyy-MM-DD
Нет
Дата начала
2022-08-02
end_date
date
yyyy-MM-DD
Нет
Дата окончания
2022-12-10
5.2.4.2.5. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.4.3. Удаление учебного плана
5.2.4.3.1. Запрос
Формат запроса
DELETE
5.2.4.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор учебного
48ce075d-8fae-4939-9c5a-
плана в ГИС СЦОС
6436497dcd86
5.2.4.3.3. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
126
5.2.5. Дисциплины
5.2.5.1. Загрузка дисциплин
5.2.5.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/disciplines -d "json_body"
5.2.5.1.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки дисциплин
Данные в формате JSON в соответствии
моделью объекта загрузки дисциплин
5.2.5.1.3. Объект загрузки дисциплин
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1
Идентификатор образовательной
2a0fc6e23c7744478ab6
до 128
организации
114add556f3e
disciplines
JSON
Список дисциплин
Данные в формате
JSON в соответствии
моделью объекта
дисциплины
5.2.5.1.4. Объект дисциплины
Параметр
Тип
Ограничение
Обязательное
Описание
Пример
external_id
string
Длина от 1 до 256
Да
Идентификатор
3a6b7fad-c800-
дисциплины в ИС ООВО
11e4-8a13-
или ИС Организации
005056c00008
title
string
Длина от 1 до 256
Да
Название дисциплины
Высшая
математика
type
string
DISCIPLINE,
Нет
Тип дисциплины:
DISCIPLINE
PRACTICE,
DISCIPLINE - дисциплина;
RESEARCH,
PRACTICE - практика;
STATE_EXAM,
RESEARCH - научные
DIPLOMA_WORK
исследования;
STATE_EXAM - ГИА;
DIPLOMA_WORK -
дипломная работа
5.2.5.1.5. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
127
5.2.5.2. Обновление дисциплины
5.2.5.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/disciplines/{id} -d "JSON_body"
5.2.5.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор дисциплины
396af457-3fd9-4294-9359-187b6f5f4a34
в ГИС СЦОС
json_body
JSON
Объект дисциплины
Данные в формате JSON в соответствии
моделью объекта дисциплины
5.2.5.2.3. Объект дисциплины
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
organization_id
string
Длина от 1 до 128
Да
Идентификатор
2a0fc6e23c774447
организации
8ab6114add556f3e
external_id
string
Длина от 1 до 256
Нет
Идентификатор
3a6b7fad-c800-
дисциплины в ИС
11e4-8a13-
ООВО или ИС
005056c00008
Организации
title
string
Длина от 1 до 256
Нет
Название
Высшая
дисциплины
математика
type
string
DISCIPLINE,
Нет
Тип дисциплины:
DISCIPLINE
PRACTICE,
DISCIPLINE -
RESEARCH,
дисциплина;
STATE_EXAM,
PRACTICE -
DIPLOMA_WORK
практика;
RESEARCH -
научные
исследования;
STATE_EXAM -
ГИА;
DIPLOMA_WORK -
дипломная работа
5.2.5.2.4. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.5.3. Удаление дисциплины
5.2.5.3.1. Запрос
Формат запроса
DELETE
128
5.2.5.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор дисциплины в ГИС
396af457-3fd9-4294-
СЦОС
9359-187b6f5f4a34
5.2.5.3.3. Ответы
Статус
Описание
200
Статус удаления данных
Success
400
bad request (bad parameters)
129
5.2.6. Связи учебных планов и дисциплин
5.2.6.1. Загрузка связи учебных планов и дисциплин
5.2.6.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/study_plans_disciplines -d "json_body"
5.2.6.1.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки связи учебного
Данные в формате JSON в соответствии
плана и дисциплины
моделью объекта загрузки связи учебного
плана и дисциплины
5.2.6.1.3. Объект загрузки связи учебного плана и дисциплины
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1
Идентификатор образовательной
2a0fc6e23c7744478ab6
до 128
организации
114add556f3e
study_plan_disc
JSON
Список связей учебного плана и
Данные в формате
iplines
дисциплины
JSON в соответствии
моделью объекта
связи учебного плана
и дисциплины
5.2.6.1.4. Объект связи учебного плана и дисциплины
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
external_id
string
Длина от 1 до 256
Нет
Идентификатор связи
cdc8015a-828d-
учебного плана и
4bf6-ac18-
дисциплины в ИС ООВО
48006af43f87
или ИС Организации
study_plan
string
Длина от 1 до 256
Да
Идентификатор учебного
3d24f7a6-c801-
плана в ИС ООВО или
11e4-8a13-
ИС Организации
005056c00008
discipline
string
Длина от 1 до 256
Да
Идентификатор
3a6b7fad-c800-
дисциплины в ИС ООВО
11e4-8a13-
или ИС Организации
005056c00008
semester
integer
Да
Номер семестра
1
130
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
mark_type
string
EXAM (или MARK),
Нет
Вид контроля:
EXAM
CREDIT,
EXAM или MARK -
DIF_CREDIT,
экзамен,
COURSE_WORK,
CREDIT - зачет,
COURSE_PROJECT
DIF_CREDIT -
HUNDRED_POINT
дифференцированный
зачет,
COURSE_WORK -
курсовая работа,
COURSE_PROJECT -
курсовой проект,
HUNDRED_POINT -
стобалльная оценка
credits
integer
Нет
Количество зачетных
100
единиц
hours
integer
Нет
Количество аудиторных
100
часов
teachers
string[]
Нет
Перечень
идентификаторов
преподавателей
kind
string
REQUIRED,
Нет
Тип дисциплины в учебном
ELECTIVE
SELECTIVE,
плане:
SPECIALITY,
REQUIRED - обязательная;
ELECTIVE
SELECTIVE - выборная
дисциплина;
SPECIALITY - входит в
специализацию;
ELECTIVE - факультатив
code_select
string
Длина от 1 до 32
Нет
Код выборного блока
1
ive
дисциплин
code_speci
string
Длина от 1 до 32
Нет
Код блока специализации
2
ality
5.2.6.1.5. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
5.2.6.2. Обновление связи учебных планов и дисциплин
5.2.6.2.1. Запрос
Формат
PUT
запроса
131
5.2.6.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор связи учебного плана и
396af457-3fd9-4294-9359-
дисциплины в ГИС СЦОС
187b6f5f4a34
json_body
JSON
Объект связи учебного плана и
Данные в формате JSON в
дисциплины
соответствии моделью объекта
связи учебного плана и дисциплины
5.2.6.2.3. Объект связи учебного плана и дисциплины
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
external_id
string
Длина от 1 до 256
Нет
Идентификатор связи
cdc8015a-828d-
учебного плана и дисциплины
4bf6-ac18-
в ИС ООВО или ИС
48006af43f87
Организации
study_plan
string
Длина от 1 до 256
Да
Идентификатор учебного
3d24f7a6-c801-
плана в ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
discipline
string
Длина от 1 до 256
Да
Идентификатор дисциплины в
3a6b7fad-c800-
ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
semester
integer
Да
Номер семестра
1
mark_type
string
EXAM (или MARK),
Нет
Вид контроля:
EXAM
CREDIT,
EXAM или MARK - экзамен,
DIF_CREDIT,
CREDIT - зачет,
COURSE_WORK,
DIF_CREDIT -
COURSE_PROJECT
дифференцированный зачет,
HUNDRED_POINT
COURSE_WORK - курсовая
работа,
COURSE_PROJECT -
курсовой проект,
HUNDRED_POINT -
стобалльная оценка
credits
integer
Нет
Количество зачетных единиц
100
hours
integer
Нет
Количество аудиторных часов
100
teachers
string[]
Нет
Перечень идентификаторов
преподавателей
kind
string
REQUIRED,
Нет
Тип дисциплины в учебном
ELECTIVE
SELECTIVE,
плане:
SPECIALITY,
REQUIRED - обязательная;
ELECTIVE
SELECTIVE - выборная
дисциплина;
SPECIALITY - входит в
специализацию;
ELECTIVE - факультатив
code_selecti
string
Длина от 1 до 32
Нет
Код выборного блока
1
ve
дисциплин
code_specia
string
Длина от 1 до 32
Нет
Код блока специализации
2
lity
132
5.2.6.2.4. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.6.3. Удаление связи учебных планов и дисциплин
5.2.6.3.1. Запрос
Формат запроса
DELETE
5.2.6.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор связи учебного плана
3d24f7a6-c801-11e4-
и дисциплины в ГИС СЦОС
8a13-005056c00008
5.2.6.3.3. Ответы
Статус
Описание
200
Статус удаления данных
Success
400
bad request (bad parameters)
5.2.6.4. Удаление дисциплины учебного плана
5.2.6.4.1. Запрос
Формат запроса
DELETE
mester={semester}
5.2.6.4.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
plan_id
UUID
Идентификатор учебного плана в
3d24f7a6-c801-11e4-
ГИС СЦОС
8a13-005056c00008
discipline_id
UUID
Идентификатор дисциплины в ГИС
3a6b7fad-c800-11e4-
СЦОС
8a13-005056c00008
semester
integer
Номер семестра
1
5.2.6.4.3. Ответы
Статус
Описание
200
Статус удаления данных
Success
400
bad request (bad parameters)
133
5.2.7. Студенты
5.2.7.1. Загрузка студентов
5.2.7.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/students -d "json_body"
5.2.7.1.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки студентов
Данные в формате JSON в соответствии
моделью объекта загрузки студентов
5.2.7.1.3. Объект загрузки студентов
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1
Идентификатор
2a0fc6e23c7744478ab6114add556f3e
до 128
организации
students
JSON
Список студентов
Данные в формате JSON в
соответствии моделью объекта
студента
5.2.7.1.4. Объект студента
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
external_id
string
Длина от 1 до 256
Да
Идентификатор студента
51b70fef-c800-
в ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
surname
string
Длина от 1 до 128
Да
Фамилия
Бажанова
name
string
Длина от 1 до 128
Да
Имя
Юлия
middle_name
string
Длина от 1 до 128
Нет
Отчество
Евгеньевна
date_of_birth
date
yyyy-MM-DD
Нет
Дата рождения
2002-01-01
snils
string
Валидное
Нет
СНИЛС
414-249-741 69
значение СНИЛС
inn
string
Валидное
Нет
ИНН
547339276204
значение ИНН
email
string
Длина от 1 до 128
Нет
Email
ybaganova@mail.r
u
phone
string
Длина от 1 до 36
Нет
Контактный номер
8 (812) 480-00-00
телефона
study_year
integer
Нет
Курс обучения студента
4
citizenship
string с
По справочнику
Нет
Гражданство по
RUS,BLR
разделите
ОКСМ в формате
справочнику ОКСМ
лем
Альфа-3 или UDF,
в формате Альфа-3,
(запятая)
длина от 1 до 36
UDF - апатрид
gender
string
MALE, FEMALE,
Нет
MALE - мужской пол,
FEMALE
UNDEFINED
FEMALE - женский пол,
UNDEFINED - пол
не определен
* Одно из полей external_id, snils, inn, email или phone обязательно должно быть заполненным
134
5.2.7.1.5. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
5.2.7.2. Обновление студента
5.2.7.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/students/{id} -d "json_body"
5.2.7.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор студента в
db6ec375-1aef-4f21-97a2-
ГИС СЦОС
3d6feea12912
json_body
JSON
Объект студента
Данные в формате JSON
в соответствии моделью объекта
студента
5.2.7.2.3. Объект студента
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
organization_id
string
Длина от 1 до 128
Да
Идентификатор
2a0fc6e23c774447
образовательной
8ab6114add556f3e
организации
external_id
string
Длина от 1 до 256
Нет
Идентификатор
51b70fef-c800-
студента в ИС ООВО
11e4-8a13-
или ИС Организации
005056c00008
surname
string
Длина от 1 до 128
Нет
Фамилия
Бажанова
name
string
Длина от 1 до 128
Нет
Имя
Юлия
middle_name
string
Длина от 1 до 128
Нет
Отчество
Евгеньевна
date_of_birth
date
yyyy-MM-DD
Нет
Дата рождения
2002-01-01
snils
string
Валидное
Нет
СНИЛС
414-249-741 69
значение СНИЛС
inn
string
Валидное
Нет
ИНН
547339276204
значение ИНН
email
string
Длина от 1 до 128
Нет
Email
ybaganova@mail.r
u
phone
string
Длина от 1 до 36
Нет
Контактный номер
8 (812) 480-00-00
телефона
study_year
integer
Нет
Курс обучения студента
citizenship
string с
По справочнику
Нет
Гражданство по
RUS,BLR
разделите
ОКСМ в формате
справочнику ОКСМ
лем
Альфа-3 или UDF,
в формате Альфа-3,
(запятая)
длина от 1 до 36
UDF - апатрид
135
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
gender
string
MALE,
Нет
MALE - мужской пол,
MALE
FEMALE,
FEMALE - женский
UNDEFINED
пол,
UNDEFINED - пол не
определен
* Одно из полей external_id, snils, inn, email или phone обязательно должно быть заполнено
5.2.7.2.4. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.7.3. Удаление студента
5.2.7.3.1. Запрос
Формат запроса
DELETE
5.2.7.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор студента
db6ec375-1aef-4f21-97a2-
в ГИС СЦОС
3d6feea12912
5.2.7.3.3. Ответы
Статус
Описание
200
Статус удаления данных
Success
400
bad request (bad parameters)
136
5.2.8. Связи студентов и учебных планов
5.2.8.1. Загрузка связи студентов и учебных планов
5.2.8.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/study_plans_students -d "json_body"
5.2.8.1.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки связи студента
Данные в формате JSON в соответствии
и учебного плана
моделью объекта загрузки связи студента и
учебного плана
5.2.8.1.3. Объект загрузки связи студентов и учебных планов
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1
Идентификатор
2a0fc6e23c7744478ab6
до 128
образовательной организации
114add556f3e
study_plan_students
JSON
Список связей студента и
Данные в формате
учебного плана
JSON в соответствии
моделью объекта
связи студента и
учебного плана
5.2.8.1.4. Объект связи студентов и учебных планов
Параметр
Тип
Ограничение
Обязательное
Описание
Пример
external_id
string
Длина от 1
Нет
Идентификатор связи
ba23fe62-6d98-
до 256
студентов и учебных
4c19-8775-
планов в ИС ООВО
c513a98a02d0
или ИС Организации
study_plan
string
Длина от 1
Да
Идентификатор
3d24f7a6-c801-
до 256
учебного плана в ИС
11e4-8a13-
ООВО или ИС
005056c00008
Организации
student
string
Длина от 1
Да
Идентификатор
51b70fef-c800-
до 256
студента в ИС ООВО
11e4-8a13-
или ИС Организации
005056c00008
start_period
integer
Нет
Номер первого
1
периода обучения
учебного плана
end_period
integer
Нет
Номер последнего
8
периода обучения
учебного плана
137
5.2.8.1.5. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
5.2.8.2. Обновление связи студентов и учебных планов
5.2.8.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/study_plans_students/{id} -d "JSON_body"
5.2.8.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор связи студента и
396af457-3fd9-4294-9359-187b6f5f4a34
учебного плана в ГИС СЦОС
json_body
JSON
Объект связи студента и учебного
Данные в формате JSON в соответствии
плана
моделью объекта связи студента и
учебного плана
5.2.8.2.3. Объект связи студента и учебного плана
Параметр
Тип
Ограничение
Обязательное
Описание
Пример
external_id
string
Длина от 1
Нет
Идентификатор связи
ba23fe62-6d98-
до 256
студентов и учебных
4c19-8775-
планов в ИС ООВО
c513a98a02d0
или ИС Организации
study_plan
string
Длина от 1
Да
Идентификатор
3d24f7a6-c801-
до 256
учебного плана в ИС
11e4-8a13-
ООВО или ИС
005056c00008
Организации
student
string
Длина от 1
Да
Идентификатор
51b70fef-c800-
до 256
студента в ИС ООВО
11e4-8a13-
или ИС Организации
005056c00008
start_period
integer
Нет
Номер первого
1
периода обучения
учебного плана
end_period
integer
Нет
Номер последнего
8
периода обучения
учебного плана
5.2.8.2.4. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
138
5.2.8.3. Удаление связи студента и учебного плана
5.2.8.3.1. Запрос студента и учебного плана
Формат запроса
DELETE
5.2.8.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор связи студента
3d24f7a6-c801-11e4-8a13-
и учебного плана в ГИС СЦОС
005056c00008
5.2.8.3.3. Ответы
Статус
Описание
200
Статус удаления данных
Success
400
bad request (bad parameters)
5.2.8.4. Удаление учебного плана студента
5.2.8.4.1. Запрос
Формат
DELETE
запроса
5.2.8.4.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
student_id
UUID
Идентификатор студента
3d24f7a6-c801-11e4-8a13-
в ГИС СЦОС
005056c00008
plan_id
UUID
Идентификатор учебного плана
db6ec375-1aef-4f21-97a2-
в ГИС СЦОС
3d6feea12912
5.2.8.4.3. Ответы
Статус
Описание
200
Статус удаления данных
Success
400
bad request (bad parameters)
139
5.2.9. Движение контингента
5.2.9.1. Загрузка движений контингента в образовательной организации
5.2.9.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/contingent_flows -d "json_body"
5.2.9.1.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки движений
Данные в формате JSON в соответствии
контингента в образовательной
моделью объекта загрузки движений
организации
контингента в образовательной организации
5.2.9.1.3. Объект загрузки движений контингента в образовательной организации
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1 до 128
Идентификатор
2a0fc6e23c7744478ab6114add55
организации
6f3e
contingent_flows
JSON
Список движений
Данные в формате JSON в
контингента в
соответствии моделью объекта
образовательной
движения контингента в
организации
образовательной организации
140
5.2.9.1.4. Объект движения контингента в образовательной организации
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
student
string
Длина от 1 до 256
Да
Идентификатор студента
51b70fef-c800-
в ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
contingent_flow
string
Длина от 1 до 128
Да
Событие
Зачисление в вуз
flow_type
string
ENROLLMENT,
Да
Тип события:
ENROLLMENT
DEDUCTION,
ENROLLMENT -
EP_TRANSFER,
зачисление;
EP_ENROLLMENT,
DEDUCTION -
TRANSFER,
отчисление;
REINSTATEMENT,
EP_TRANSFER -
SABBATICAL_TAKING,
прекращение обучения
SABBATICAL_EXTENSI
на образовательной
ON,
программе в связи с
SABBATICAL_RETURN
переводом на другую
внутри ООВО;
EP_ENROLLMENT -
зачисление на другую
образовательную
программу в связи
с переводом;
TRANSFER - перевод;
REINSTATEMENT -
восстановление;
SABBATICAL_TAKING
- выход в академический
отпуск;
SABBATICAL_EXTENS
ION - продление
академического отпуска;
SABBATICAL_RETUR
N - выход из отпуска
date
date
yyyy-MM-DD
Да
Дата
2022-08-21
faculty
string
Длина от 1 до 256
Нет
Название факультета
ФВТ
education_form
string
FULL_TIME,
Да
Форма обучения:
FULL_TIME
PART_TIME,
FULL_TIME - очная;
EXTRAMURAL,
PART_TIME - очно-
SHORT_FULL_TIME,
заочная;
SHORT_PART_TIME,
EXTRAMURAL -
SHORT_EXTRAMURAL,
заочная;
EXTERNAL,
SHORT_FULL_TIME -
UNDEFINED
сокращенная очная;
SHORT_PART_TIME -
сокращенная очно-
заочная;
SHORT_EXTRAMURAL
- сокращенная заочная;
EXTERNAL - экстернат;
UNDEFINED -
не определена
form_fin
string
BUDGET,
Нет
Форма финансирования:
BUDGET
SPECIAL_PURPOSE,
BUDGET - бюджет,
CONTRACT
SPECIAL_PURPOSE -
(временно доступна
целевое финансирование,
возможность загрузки
CONTRACT - договор
произвольной строки)
оказания
образовательных услуг
special_right
boolean
Нет
Признак особого права
true
формы финансирования
141
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
type_fin
string
FEDERAL, SUBJECT,
Нет
Тип финансирования:
FEDERAL
LOCAL
FEDERAL -
федеральный бюджет;
SUBJECT - бюджет
субъекта Российской
Федерации;
LOCAL - местный
бюджет
details
string
Длина от 1 до 256
Нет
Дополнительные
Дополнительная
сведения. Поле не
информация
рекомендуется
использовать.
external_id
string
Длина от 1 до 256
Нет
Идентификатор
1430662d-92e2-
движения контингента в
4fa1-bdc5-
ИС ООВО или ИС
c64cbe724958
Организации
educational_progra
string
Длина от 1 до 256
Нет
Идентификатор
fb75c23d-1cf9-
m
образовательной
4cde-b1a3-
программы в ИС ООВО
8a37ee47e80a
или ИС Организации
contract_details
JSON
Нет
Реквизиты договора (о
Данные
платном или целевом
в формате JSON
обучении)
в соответствии
моделью объекта
реквизитов
договора
(о платном или
целевом
обучении)
education_level
string
UNDERGRADUATE,
Нет
Уровень образования:
POSTGRADUAT
MAGISTRACY,
UNDERGRADUATE -
E
SPECIALTY,
бакалавриат;
POSTGRADUATE,
MAGISTRACY -
ADJUNCT,
магистратура;
RESIDENCY,
SPECIALTY -
ASSISTANT_INTERNSHI
специалитет;
P
POSTGRADUATE -
аспирантура;
ADJUNCT -
адъюнктура;
RESIDENCY -
ординатура;
ASSISTANT_INTERNS
HIP - ассистентура-
стажировка
speciality_code
string
Длина от 1 до 20
Нет
Код научной
03.03.06
специальности (для
аспирантов)
speciality_name
string
Длина от 1 до 255
Нет
Наименование научной
Нейробиология
специальности (для
аспирантов)
order_details
JSON
Нет
Сведения о приказе
Данные
в формате JSON
в соответствии
моделью объекта
сведений
о приказе
142
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
flow_details
JSON
Нет
Детальная информация
Данные
по движению
в формате JSON
в соответствии
моделью
детальной
информации
по движению
study_year
integer
Нет
Год обучения
1
study_start_date
date
yyyy-MM-dd
Нет
Дата начала обучения
2022-09-01
study_end_date
date
yyyy-MM-dd
Нет
Дата предполагаемого
2026-08-31
окончания обучения
student_card
JSON
Нет
Объект студенческого
Данные
билета
в формате JSON
в соответствии
моделью
студенческого
билета
gradebook
JSON
Нет
Объект зачетной книжки
Данные
в формате JSON
в соответствии
моделью
зачетной книжки
5.2.9.1.5. Объект загрузки реквизита договора (о платном или целевом обучении)
Все параметры являются необязательными
Параметр
Тип
Ограничение
Описание
Пример
target_contract_number
string
Номер договора (целевой
ДР-003-1
договор или договор о
платном обучении)
target_contract_date
date
yyyy-MM-dd
Дата договора (целевой
2022-08-01
договор или договор о
платном обучении)
customer_name
string
Наименование заказчика
Октябрьская школа
(для целевого договора)
№ 3
customer_inn
string
ИНН заказчика (для
1711468260
целевого договора)
customer_orgn
string
ОГРН заказчика (для
9018342585626
целевого договора)
employer_name
string
Наименование работодателя
Национальный
(для целевого договора)
исследовательский
университет ИТМО
employer_inn
string
ИНН работодателя (для
2556432452
целевого договора)
employer_ogrn
string
ОГРН работодателя (для
4102973039517
целевого договора)
5.2.9.1.6. Объект загрузки сведений о приказе
Все параметры являются необязательными
Параметр
Тип
Ограничение
Описание
Пример
order_number
string
Номер приказа
1
order_date
date
yyyy-MM-dd
Дата приказа
2022-08-01
143
5.2.9.1.7. Объект загрузки студенческого билета
Все параметры являются необязательными
Параметр
Тип
Ограничение
Описание
Пример
number
string
Номер студенческого билета
1
start_date
date
yyyy-MM-dd
Дата начала действия
2023-08-11
студенческого билета
end_date
date
yyyy-MM-dd
Дата окончания действия
2023-08-11
студенческого билета
5.2.9.1.8. Объект загрузки зачетной книжки
Все параметры являются необязательными
Параметр
Тип
Ограничение
Описание
Пример
number
string
Номер зачетной книжки
1
date
date
yyyy-MM-dd
Дата выдачи зачетной книжки
2023-08-11
5.2.9.1.9. Объект загрузки детальной информации по движению
Все параметры являются необязательными
Параметр
Тип
Ограничение
Описание
Пример
reason
string
Справочник
Причина отчисления, причина
DED_GRADUATION
значений (приведен
выхода в академический
после таблицы)
отпуск, причина продления
академического отпуска
start_date
date
yyyy-MM-dd
Дата начала академического
2022-08-01
отпуска
end_date
date
yyyy-MM-dd
Дата окончания
2023-08-01
академического отпуска
Справочник значений для поля «reason» делится на два блока: значения для причин
отчисления (коды причин начинаются с DED_) и значения причин для академического отпуска
(коды причин начинаются с SAB_). Возможные значения приведены ниже.
Причины отчисления:
DED_GRADUATION - Отчислить в связи с получением образования (завершением обучения);
DED_VOLUNTARILY - Отчисление по собственному желанию;
DED_HEALTH - Отчисление по состоянию здоровья;
DED_DEATH - Отчисление в связи со смертью;
DED_SOLDIER - Отчисление в связи с призывом на военную службу в ВС РФ;
DED_UNDERPERFORMANCE - Отчисление за академическую неуспеваемость;
DED_STUDIES_NEVER_STARTED - Отчисление как не приступившего к занятиям;
DED_TRANSFER_INSTITUTION - Отчисление в связи с переводом в другую образовательную
организацию;
DED_TRANSFER_FACULTY - Отчисление в связи с переводом (на другой факультет);
DED_CONTRACT_DISREGARD - Отчисление в связи с невыполнением условий договора;
DED_NON_PAYMENT - Отчисление в связи с неоплатой обучения;
DED_CONTRACT_AVOIDANCE - Отчисление в связи с расторжением договора на обучение
(по неуважительной причине);
DED_TRANSFER_FULL_TIME - Отчисление в связи с переводом на очное обучение;
DED_TRANSFER_PART_TIME - Отчисление в связи с переводом на очно-заочное отделение;
DED_TRANSFER_EXTRAMURAL - Отчисление в связи с переводом на заочное отделение;
DED_STUDIES_STOP_ATTEND - Отчисление в связи с прекращением посещения занятий;
144
DED_REGULATIONS_VIOLATION
- Отчисление за нарушение правил внутреннего
распорядка;
DED_SABBATICAL_ABSENCE - Отчисление как не вернувшегося из академического отпуска;
DED_STATE_EXAM_NON_ADMISSION - Отчисление как недопущенного к государственной
итоговой аттестации;
DED_STATE_EXAM_FAILED
- Отчисление как не прошедшего государственное
аттестационное испытание;
DED_ORGANIZATION_LIQUIDATION - Отчисление в связи с ликвидацией образовательной
организации;
DED_CRIME - Отчисление в связи с вступлением в силу обвинительного приговора суда за
совершение преступления.
Причины выхода в академический отпуск, причины продления академического отпуска:
SAB_STUDY_INABILITY - В связи с невозможностью освоения образовательной программы
высшего образования;
SAB_FAMILY - По семейным обстоятельствам;
SAB_CHILD_THREE - По уходу за ребенком до 3 лет;
SAB_CHILD_ONE_AND_HALF - По уходу за ребенком до 1,5 лет;
SAB_HEALTH - По медицинским показаниям;
SAB_SOLDIER - В связи с призывом на военную службу;
SAB_STUDY_SENT - Направить для обучения;
SAB_PREGNANCY - По беременности и родам;
SAB_OPERATIONAL_NEED - В связи с производственной необходимостью;
SAB_FINANCIAL - В связи с существенным ухудшением материального положения;
SAB_COMPETITION - В связи с участием в официальных всероссийских и международных
соревнованиях;
SAB_CALAMITY - В связи с происшедшим стихийным бедствием;
SAB_STARTUP - В связи с созданием университетского стартапа;
SAB_OTHER - Иная причина.
5.2.9.1.10. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
5.2.9.2. Обновление движения контингента в образовательной организации
5.2.9.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/contingent_flows/{id} -d "json_body"
5.2.9.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
145
id
UUID
Идентификатор движения
68441448-90e7-43e0-b986-4b0357e53525
контингента в ГИС СЦОС
json_body
JSON
Объект движения контингента
Данные в формате JSON в соответствии
в образовательной организации
моделью объекта движения контингента
в образовательной организации
5.2.9.2.3. Объект движения контингента в образовательной организации
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
organization_id
string
Длина от 1 до 128
Да
Идентификатор
2a0fc6e23c774447
образовательной
8ab6114add556f3e
организации
student
string
Длина от 1 до 256
Да
Идентификатор студента в
51b70fef-c800-
ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
contingent_flo
string
Длина от 1 до 128
Да
Событие
Зачисление в вуз
w
flow_type
string
ENROLLMENT,
Да
Тип события:
ENROLLMENT
DEDUCTION,
ENROLLMENT -
EP_TRANSFER,
зачисление;
EP_ENROLLMENT,
DEDUCTION - отчисление;
TRANSFER,
EP_TRANSFER -
REINSTATEMENT,
прекращение обучения на
SABBATICAL_TAKING,
образовательной программе
SABBATICAL_EXTENSION,
в связи с переводом на
SABBATICAL_RETURN
другую внутри ООВО;
EP_ENROLLMENT -
зачисление на другую
образовательную программу
в связи с переводом;
TRANSFER - перевод;
REINSTATEMENT -
восстановление;
SABBATICAL_TAKING -
выход в академический
отпуск;
SABBATICAL_EXTENSIO
N - продление
академического отпуска;
SABBATICAL_RETURN -
выход из отпуска
date
date
yyyy-MM-DD
Да
Дата
2022-08-21
faculty
string
Длина от 1 до 256
Нет
Название факультета
ФВТ
education_form
string
FULL_TIME,
Да
Форма обучения:
FULL_TIME
PART_TIME,
FULL_TIME - очная;
EXTRAMURAL,
PART_TIME - очно-заочная;
SHORT_FULL_TIME,
EXTRAMURAL - заочная;
SHORT_PART_TIME,
SHORT_FULL_TIME -
SHORT_EXTRAMURAL,
сокращенная очная;
EXTERNAL,
SHORT_PART_TIME -
UNDEFINED
сокращенная очно-заочная;
SHORT_EXTRAMURAL -
сокращенная заочная;
EXTERNAL - экстернат;
UNDEFINED -
не определена
146
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
form_fin
string
BUDGET,
Нет
Форма финансирования:
BUDGET
SPECIAL_PURPOSE,
BUDGET - бюджет,
CONTRACT
SPECIAL_PURPOSE -
(временно доступна
целевое финансирование,
возможность загрузки
CONTRACT - договор
произвольной строки)
оказания образовательных
услуг
special_right
boole
Нет
Признак особого права
true
an
формы финансирования
type_fin
string
FEDERAL,
Нет
Тип финансирования:
FEDERAL
SUBJECT,
FEDERAL - федеральный
LOCAL
бюджет;
SUBJECT - бюджет
субъекта Российской
Федерации;
LOCAL - местный бюджет
details
string
Длина от 1 до 256
Нет
Дополнительные сведения.
Дополнительная
Поле не рекомендуется
информация
использовать
external_id
string
Длина от 1 до 256
Нет
Идентификатор движения
1430662d-92e2-
контингента в ИС ООВО
4fa1-bdc5-
или ИС Организации
c64cbe724958
educational_pro
string
Длина от 1 до 256
Нет
Идентификатор
fb75c23d-1cf9-
gram
образовательной программы
4cde-b1a3-
в ИС ООВО или ИС
8a37ee47e80a
Организации
contract_details
JSON
Нет
Реквизиты договора (о
Данные в
платном или целевом
формате JSON в
обучении)
соответствии
моделью объекта
реквизитов
договора (о
платном или
целевом
обучении)
education_level
string
UNDERGRADUATE,
Нет
Уровень образования:
POSTGRADUAT
MAGISTRACY,
UNDERGRADUATE -
E
SPECIALTY,
бакалавриат;
POSTGRADUATE,
MAGISTRACY -
ADJUNCT,
магистратура;
RESIDENCY,
SPECIALTY - специалитет;
ASSISTANT_INTERNSHIP
POSTGRADUATE -
аспирантура;
ADJUNCT - адъюнктура;
RESIDENCY - ординатура;
ASSISTANT_INTERNSHIP
– ассистентура-стажировка
speciality_code
string
Длина от 1 до 20
Нет
Код научной специальности
03.03.06
(для аспирантов)
speciality_nam
string
Длина от 1 до 255
Нет
Наименование научной
Нейробиология
e
специальности (для
аспирантов)
order_details
JSON
Нет
Сведения о приказе
Данные в
формате JSON в
соответствии
моделью объекта
сведений о
приказе
147
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
flow_details
JSON
Нет
Детальная информация по
Данные в
движению
формате JSON в
соответствии
моделью
детальной
информации по
движению
study_year
intege
Нет
Год обучения
1
r
study_start_dat
date
yyyy-MM-dd
Нет
Дата начала обучения
2022
e
study_end_date
date
yyyy-MM-dd
Нет
Дата предполагаемого
2026
окончания обучения
5.2.9.2.4. Объект загрузки реквизита договора (о платном или целевом обучении)
Все параметры являются не обязательными
Параметр
Тип
Ограничение
Описание
Пример
target_contract_
string
Номер договора (целевой
ДР-003-1
number
договор или договор о
платном обучении)
target_contract_
date
yyyy-MM-dd
Дата договора (целевой
2022-08-01
date
договор или договор о
платном обучении)
customer_name
string
Наименование заказчика
Октябрьская школа № 3
(для целевого договора)
customer_inn
string
ИНН заказчика (для
1711468260
целевого договора)
customer_ogrn
string
ОГРН заказчика (для
4102973039517
целевого договора)
employer_name
string
Наименование работодателя
Национальный
(для целевого договора)
исследовательский
университет ИТМО
employer_inn
string
ИНН работодателя (для
2556432452
целевого договора)
employer_ogrn
string
ОГРН работодателя (для
9018342585626
целевого договора)
5.2.9.2.5. Объект загрузки сведений о приказе
Все параметры являются не обязательными
Параметр
Тип
Ограничение
Описание
Пример
order_number
string
Номер приказа
1
order_date
date
yyyy-MM-dd
Дата приказа
2022-08-01
5.2.9.2.6. Объект загрузки детальной информации по движению
Все параметры являются не обязательными
Параметр
Тип
Ограничение
Описание
Пример
reason
string
Справочник
Причина отчисления, причина
DED_GRADUATION
значений (приведен
выхода в академический
после таблицы)
отпуск, причина продления
академического отпуска
start_date
date
yyyy-MM-dd
Дата начала академического
2022-08-01
отпуска
148
Параметр
Тип
Ограничение
Описание
Пример
end_date
date
yyyy-MM-dd
Дата окончания
2023-08-01
академического отпуска
Справочник значений для поля «reason» делится на два блока: значения для причин
отчисления (коды причин начинаются с DED_) и значения причин для академического отпуска
(коды причин начинаются с SAB_). Возможные значения приведены ниже.
Причины отчисления:
DED_GRADUATION - Отчислить в связи с получением образования (завершением обучения);
DED_VOLUNTARILY - Отчисление по собственному желанию;
DED_HEALTH - Отчисление по состоянию здоровья;
DED_DEATH - Отчисление в связи со смертью;
DED_SOLDIER - Отчисление в связи с призывом на военную службу в ВС РФ;
DED_UNDERPERFORMANCE - Отчисление за академическую неуспеваемость;
DED_STUDIES_NEVER_STARTED - Отчисление как не приступившего к занятиям;
DED_TRANSFER_INSTITUTION - Отчисление в связи с переводом в другую образовательную
организацию;
DED_TRANSFER_FACULTY - Отчисление в связи с переводом (на другой факультет);
DED_CONTRACT_DISREGARD - Отчисление в связи с невыполнением условий договора;
DED_NON_PAYMENT - Отчисление в связи с неоплатой обучения;
DED_CONTRACT_AVOIDANCE - Отчисление в связи с расторжением договора на обучение
(по неуважительной причине);
DED_TRANSFER_FULL_TIME - Отчисление в связи с переводом на очное обучение;
DED_TRANSFER_PART_TIME - Отчисление в связи с переводом на очно-заочное отделение;
DED_TRANSFER_EXTRAMURAL - Отчисление в связи с переводом на заочное отделение;
DED_STUDIES_STOP_ATTEND - Отчисление в связи с прекращением посещения занятий;
DED_REGULATIONS_VIOLATION
- Отчисление за нарушение правил внутреннего
распорядка;
DED_SABBATICAL_ABSENCE - Отчисление как не вернувшегося из академического отпуска;
DED_STATE_EXAM_NON_ADMISSION - Отчисление как недопущенного к государственной
итоговой аттестации;
DED_STATE_EXAM_FAILED
- Отчисление как не прошедшего государственное
аттестационное испытание;
DED_ORGANIZATION_LIQUIDATION - Отчисление в связи с ликвидацией образовательной
организации;
DED_CRIME - Отчисление в связи с вступлением в силу обвинительного приговора суда за
совершение преступления.
Причины выхода в академический отпуск, причины продления академического отпуска:
SAB_STUDY_INABILITY - В связи с невозможностью освоения образовательной программы
высшего образования;
SAB_FAMILY - По семейным обстоятельствам;
SAB_CHILD_THREE - По уходу за ребенком до 3 лет;
SAB_CHILD_ONE_AND_HALF - По уходу за ребенком до 1,5 лет;
SAB_HEALTH - По медицинским показаниям;
SAB_SOLDIER - В связи с призывом на военную службу;
SAB_STUDY_SENT - Направить для обучения;
149
SAB_PREGNANCY - По беременности и родам;
SAB_OPERATIONAL_NEED - В связи с производственной необходимостью;
SAB_FINANCIAL - В связи с существенным ухудшением материального положения;
SAB_COMPETITION - В связи с участием в официальных всероссийских и международных
соревнованиях;
SAB_CALAMITY - В связи с происшедшим стихийным бедствием;
SAB_STARTUP - В связи с созданием университетского стартапа;
SAB_OTHER - Иная причина.
5.2.9.2.7. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.9.3. Удаление движения контингента студента
5.2.9.3.1. Запрос
Формат запроса
DELETE
5.2.9.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор движения
68441448-90e7-43e0-
контингента студента в ГИС СЦОС
b986-4b0357e53525
5.2.9.3.3. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
150
5.2.10. Оценки
5.2.10.1. Загрузка оценок
5.2.10.1.1. Запрос
Формат запроса
POST
https://online.edu.ru/vam/api/v2/marks -d "json_body"
5.2.10.1.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Описание
Пример
json_body
JSON
Объект загрузки оценок
Данные в формате JSON в соответствии моделью
объекта загрузки оценок
5.2.10.1.3. Объект загрузки оценок
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1 до 128
Идентификатор
2a0fc6e23c7744478ab6114add556f3e
организации
marks
JSON
Список оценок
Данные в формате JSON
в соответствии моделью объекта
оценки
5.2.10.1.4. Объект оценки
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
external_id
string
Длина от 1 до 256
Нет
Идентификатор оценки в ИС
01f63fb0ebb711eb
ООВО или ИС Организации
ae2887f72ebb4f68
discipline
string
Длина от 1 до 256
Да
Идентификатор дисциплины в
3a6b7fad-c800-
ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
study_plan
string
Длина от 1 до 256
Да
Идентификатор учебного
3d24f7a6-c801-
плана в ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
student
string
Длина от 1 до 256
Да
Идентификатор студента в ИС
51b70fef-c800-
ООВО или ИС Организации
11e4-8a13-
005056c00008
mark_type
string
EXAM (или MARK),
Да
Вид контроля:
EXAM
CREDIT,
EXAM или MARK - экзамен,
DIF_CREDIT,
CREDIT - зачет,
COURSE_WORK,
DIF_CREDIT -
COURSE_PROJECT
дифференцированный зачет,
HUNDRED_POINT
COURSE_WORK - курсовая
работа,
COURSE_PROJECT -
курсовой проект,
HUNDRED_POINT -
стобалльная оценка
mark_value
integer
Нет
Оценка
4
151
Обязат
Параметр
Тип
Ограничение
Описание
Пример
ельное
normal_mark
string
FAILED,
Нет
Значение оценки, приведенное
GOOD
_value
PASSED,
к шкале ENUM:
UNSATISFACTORY,
FAILED - незачет,
SATISFACTORY,
PASSED - зачет,
GOOD,
UNSATISFACTORY - 2
EXCELLENT,
(неудовл.),
ABSENCE,
SATISFACTORY - 3
REASONABLE_ABSENCE,
(удовлетворительно),
NON_ADMISSION,
GOOD - 4 (хорошо),
RELEASE
EXCELLENT - 5 (отлично),
ABSENCE - неявка,
REASONABLE_ABSENCE -
неявка по уважительной
причине,
NON_ADMISSION -
недопуск,
RELEASE - освобождение
semester
integer
Нет
Номер семестра
1
teacher
string
Длина от 1 до 256
Нет
Идентификатор
1be446a4-c047-
преподавателя, выставившего
4073-bf7b-
оценка в ИС ООВО или ИС
8b320a2d9ff5
Организации
date
date
yyyy-MM-DD
Нет
Дата выставления оценки
2022-01-21
reset
boolean
Нет
Признак перезачета
false
details
JSON
Нет
Дополнительные сведения о
Данные в
практике, курсовой работе,
формате JSON в
ГИА
соответствии
моделью объекта
дополнительных
сведений о
практике,
курсовой работе,
ГИА
5.2.10.1.5. Объект загрузки дополнительных сведений о практике, курсовой работе, ГИА
Все параметры являются не обязательными
Параметр
Тип
Ограничение
Описание
Пример
company_name
string
Наименование предприятия,
ОАО Тех
на котором проходит
практика
company_inn
string
ИНН предприятия
7535867927
company_ogrn
string
ОГРН предприятия
4102973039517
practice_start_date
date
yyyy-MM-dd
Дата начала практики
2022-06-01
practice_end_date
date
yyyy-MM-dd
Дата окончания практики
2022-07-05
comission_chairman_name
string
Имя председателя комиссии
Полина
comission_chairman_surname
string
Фамилия председателя
Краснобаева
комиссии
comission_chairman_middle_n
string
Отчество председателя
Германовна
ame
комиссии
comission_chairman_position
string
Должность председателя
Директор
комиссии
vkr_title
string
Тема ВКР
Повышение
эффективности
операций в цепях
поставок
scientific_director_name
string
Имя научного руководителя
Егор
152
Параметр
Тип
Ограничение
Описание
Пример
scientific_director_surname
string
Фамилия научного
Куксюк
руководителя
scientific_director_middle_na
string
Отчество научного
Тимофеевич
me
руководителя
commission_chairman_organiz
string
Наименование организации,
ОАО Тех
ation_title
в которой работает
председатель комиссии
commission_chairman_organiz
string
ИНН организации, в которой
7535867927
ation_inn
работает председатель
комиссии
course_work_title
string
Тема курсовой
Информационные
работы/проекта
системы цифровой
экономики
5.2.10.1.6. Ответы
Статус
Описание
200
Статус загрузки данных
Success
202
Пакет загружен частично из-за наличия ошибок в массиве объектов.
400
bad request (bad parameters)
5.2.10.2. Обновление оценки
5.2.10.2.1. Запрос
Формат запроса
PUT
https://online.edu.ru/vam/api/v2/marks/{id} -d "json_body"
5.2.10.2.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор
f7b694c4-7403-483b-a896-765adc222946
оценки в ГИС СЦОС
json_body
JSON
Объект оценки
Данные в формате JSON в
соответствии моделью объекта оценки
5.2.10.2.3. Объект оценки
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
organization_id
string
Длина от 1 до 128
Да
Идентификатор
2a0fc6e23c7744478
образовательной
ab6114add556f3e
организации
external_id
string
Длина от 1 до 256
Нет
Идентификатор оценки в ИС
01f63fb0ebb711eba
ООВО или ИС Организации
e2887f72ebb4f68
discipline
string
Длина от 1 до 256
Да
Идентификатор дисциплины
3a6b7fad-c800-
в ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
study_plan
string
Длина от 1 до 256
Да
Идентификатор учебного
3d24f7a6-c801-
плана в ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
student
string
Длина от 1 до 256
Да
Идентификатор студента в
51b70fef-c800-
ИС ООВО или ИС
11e4-8a13-
Организации
005056c00008
153
Обязате
Параметр
Тип
Ограничение
Описание
Пример
льное
mark_type
string
EXAM (или MARK),
Да
Вид контроля:
EXAM
CREDIT,
EXAM или MARK -
DIF_CREDIT,
экзамен,
COURSE_WORK,
CREDIT - зачет,
COURSE_PROJECT
DIF_CREDIT -
HUNDRED_POINT
дифференцированный зачет,
COURSE_WORK - курсовая
работа,
COURSE_PROJECT -
курсовой проект,
HUNDRED_POINT -
стобалльная оценка
mark_value
integer
Да
Оценка
4
normal_mark_
string
FAILED,
Нет
Значение оценки,
GOOD
value
PASSED,
приведенное к шкале ENUM:
UNSATISFACTORY,
FAILED - незачет,
SATISFACTORY,
PASSED - зачет,
GOOD,
UNSATISFACTORY - 2
EXCELLENT,
(неудовл.),
ABSENCE,
SATISFACTORY - 3
REASONABLE_ABSEN
(удовлетворительно),
CE,
GOOD - 4 (хорошо),
NON_ADMISSION,
EXCELLENT - 5 (отлично),
RELEASE
ABSENCE - неявка,
REASONABLE_ABSENCE
- неявка по уважительной
причине,
NON_ADMISSION -
недопуск,
RELEASE - освобождение
semester
integer
Да
Номер семестра
1
teacher
string
Длина от 1 до 256
Нет
Идентификатор
1be446a4-c047-
преподавателя,
4073-bf7b-
выставившего оценка в ИС
8b320a2d9ff5
ООВО или ИС Организации
date
date
yyyy-MM-DD
Нет
Дата выставления оценки
2022-01-21
reset
boolean
Нет
Признак перезачета
false
details
JSON
Нет
Дополнительные сведения о
Данные в формате
практике, курсовой работе,
JSON в
ГИА
соответствии
моделью объекта
дополнительных
сведений о
практике, курсовой
работе, ГИА
5.2.10.2.4. Объект загрузки дополнительных сведений о практике, курсовой работе, ГИА
Все параметры являются не обязательными
Параметр
Тип
Ограничение
Описание
Пример
company_name
string
Наименование предприятия, на
ОАО Тех
котором проходит практика
company_inn
string
ИНН предприятия
7535867927
company_ogrn
string
ОГРН предприятия
9018342585626
practice_start_date
date
yyyy-MM-dd
Дата начала практики
2022-06-01
practice_end_date
date
yyyy-MM-dd
Дата окончания практики
2022-07-05
comission_chairman_name
string
Имя председателя комиссии
Полина
comission_chairman_surname
string
Фамилия председателя
Краснобаева
комиссии
154
Параметр
Тип
Ограничение
Описание
Пример
comission_chairman_middle_na
string
Отчество председателя
Германовна
me
комиссии
comission_chairman_position
string
Должность председателя
Директор
комиссии
vkr_title
string
Тема ВКР
Повышение
эффективности
операций в цепях
поставок
scientific_director_name
string
Имя научного руководителя
Егор
scientific_director_surname
string
Фамилия научного
Куксюк
руководителя
scientific_director_middle_nam
string
Отчество научного
Тимофеевич
e
руководителя
commission_chairman_organiza
string
Наименование организации, в
ОАО Тех
tion_title
которой работает председатель
комиссии
commission_chairman_organiza
string
ИНН организации, в которой
7535867927
tion_inn
работает председатель
комиссии
course_work_title
string
Тема курсовой работы/проекта
Информационные
системы
цифровой
экономики
5.2.10.2.5. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
5.2.10.3. Удаление оценки
5.2.10.3.1. Запрос
Формат запроса
DELETE
5.2.10.3.2. Параметры запроса
Все параметры являются обязательными
Параметр
Тип
Ограничение
Описание
Пример
id
UUID
Идентификатор оценки в
f7b694c4-7403-483b-
ГИС СЦОС
a896-765adc222946
5.2.10.3.3. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
155
5.2.11. Завершение интеграционного взаимодействия
5.2.11.1. Завершение интеграционного взаимодействия
5.2.11.1.1. Запрос
Формат запроса
POST
5.2.11.1.2. Параметры запроса
Все параметры являются необязательными
Параметр
Тип
Ограничение
Описание
Пример
organization_id
string
Длина от 1 до 128
Идентификатор ООВО
8e5bb17a-524d-4277-
80d2-2478304758e2
5.2.11.1.3. Ответы
Статус
Описание
200
Статус загрузки данных
Success
400
bad request (bad parameters)
156
5.3. Сведения о статусах интеграционного взаимодействия
5.3.1. Получение списка данных о статусах интеграционного
взаимодействия
5.3.1.1. Запрос
Формат запроса
GET
status={status}
5.3.1.2. Параметры запроса
Все параметры не являются обязательными
Параметр
Тип
Описание
Пример
integration
string
Тип интеграционного взаимодействия
STUDY_PLAN
COURSE
ORGANIZATION
CONTRACT_CONTRACT_LINE
DISCIPLINE
EDUCATIONAL_PROGRAM
MARK
CONTINGENT_FLOW
STUDENT
STUDY_PLANS_DISCIPLINE
STUDY_PLAN
STUDY_PLANS_STUDENT
status
string
Статус интеграционного взаимодействия
SUCCESS
SUCCESS
FAILED
5.3.1.3. Ответы
Статус
Описание
200
JSON со списком данных о статусах интеграционного взаимодействия
[
{
"createdAt": "2022-10-18T00:39:04.731+00:00",
"type": "FINISHED",
"status": "SUCCESS",
"details": null
},
{
"createdAt": "2022-10-18T00:38:31.599+00:00",
"type": "INITIALIZATION",
"status": "SUCCESS",
"details": null
}
]
400
bad request (bad parameters)
157
5.3.1.4. Объект списка данных о статусах интеграционного взаимодействия
Название
Тип
Описание
Пример
id
UUID
id конфигурации
d8c1b997-f1cd-4e96-8485-
3b9c51ed2ebc
title
string
Название конфигурации
Вакансии госслужбы из
ЕИСУКС
informationType
string
Вид сведений
GOSSLUZHBA
classifier
string
Классификатор
vacancies
type
string
Тип конфигурации
REST
success
string
Статус успешности
true
date
string
Дата интеграционного
2022-09-21T19:34:48.715+00:00
взаимодействия
5.3.2. Получение данных о статусах интеграционного взаимодействия
5.3.2.1. Запрос
Формат запроса
GET
5.3.2.2. Параметры запроса
Параметр
Тип
Описание
Пример
id
UUID
Идентификатор
22de94f0-72c3-4e91-
интеграционной сессии
8d4a-24e65a20a64c
5.3.2.3. Ответы
Статус
Описание
200
JSON со списком данными о статусах интеграционного взаимодействия
[
{
"createdAt": "2022-09-21T20:06:45.052+00:00",
"type": "FINISHED",
"status": "SUCCESS",
"details": null
},
{
"createdAt": "2022-09-21T20:06:44.825+00:00",
"type": "RESPONSE_RECEIVED",
"status": "SUCCESS",
"details": null
}
]
400
bad request (bad parameters)
5.3.2.4. Объект данных о статусах интеграционного взаимодействия
Название
Тип
Описание
Пример
createdAt
string
Дата создания записи о событии
2022-09-21T20:06:45.052+00:00
type
string
Тип события
SEND_REQUEST
status
string
Статус события
FAILED
details
string
Детали ошибки
502 Bad Gateway
158
6. Реестр программ ДПО
6.1. Программы дополнительного образования
6.1.1. Описание запросов
6.1.1.1. Создание программы ДПО
Добавление дополнительной образовательной программы.
Формат
POST /api/v2/additional_education/programs
запроса
Тело запроса
Содержит JSON объекта программы дополнительного образования [Таблица
6.1.2.1].
Возвращаемое
HTTP response status 201. (Created) - программа ДПО прошла предварительную
значение
валидацию и сохранена в сервисе со статусом “на модерации”. В теле запроса
приходит global id созданной программы
HTTP response status 400 (Bad Request) - был принят неверный объект программы
ДПО или послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на добавление: попытка
добавить программу в стороннюю организацию, у пользователя нет прав на запись
программ ДПО.
6.1.1.2. Обновление программы ДПО
Обновление существующей программы ДПО.
Формат
PUT /api/v2/additional_education/programs
запроса
Тело запроса
Содержит JSON объекта программы дополнительного образования.
[Таблица 6.1.2.1].
Возвращаемое
HTTP response status 200 (OK) - программа ДПО прошла предварительную
значение
валидацию, и обновленная версия сохранена в сервисе со статусом “на модерации”.
В теле запроса приходит global id созданной программы.
HTTP response status 400 (Bad Request) - был принят неверный объект программы
ДПО или послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав: попытка изменить
программу сторонней организации, у пользователя нет прав на запись программ
ДПО.
6.1.1.3. Смена статуса программы ДПО
Смена статуса программы ДПО. Смена статуса на “Архивный” означает удаление программы
дополнительного образования. Статус невозможно изменить, если текущий статус программы
ДПО - «На модерации».
Формат
POST /api/v2/additional_education/programs/status
запроса
Тело запроса
Содержит JSON объекта смены статуса [Таблица 6.1.2.8].
Возвращаемое
HTTP response status 200 (OK) - статус успешно изменен
значение
HTTP response status 400 (Bad Request) - был принят неверный объект или послан
неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав: попытка изменить
программу сторонней организации, у пользователя нет прав на запись программ
ДПО.
159
6.1.1.4. Получение программы
Получение информации о программе
Формат
GET /api/v2/additional_education/programs/{programId}
запроса
Возвращаемое
HTTP response status 200 (OK) - Программа получена. В теле ответа JSON объекта
значение
программы ДПО [Таблица 6.1.2.1] с дополнительными полями [Таблица 6.1.2.9]
HTTP response status 400 (Bad Request) - был послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав: попытка изменить
программу сторонней организации, у пользователя нет прав на чтение программ
ДПО.
6.1.2. Описание объектов
6.1.2.1. Объект «Программа ДПО»
Обязательн
Название
Тип
Ограничения
Описание
Пример
ое
global_id
string
Необходим при
Да - при
Идентификатор
957c81f9-68d1-4f1a-
обновлении
обновлении
программы
8a8b-d08914956fe4
программы
программы
name
string
Да
Название программы
Социальное
ДПО
проектирование в
образовании и
практике
воспитательной
работы
description
string
Да
Описание программы
Программа
ДПО
дополнительного
образования, которая
специализируется на
работе.
program_type
string
DPO,
Да
Тип программы ДПО:
DPO
SPO,
DPO - дополнительное
DO
профессиональное
образование,
SPO - среднее
профессиональное
образование,
DO - дополнительное
образование.
program_categ
string
TRAINING,
Нет
Категория программы
TRAINING
ory
PROFESSIONA
ДПО:
L_RETRAININ
TRAINING -
G
повышение
квалификации,
PROFESSIONAL_RET
RAINING -
провессиональная
переподготовка
enlarged_traini
string
Нет
Наименование
Социология
ng_direction
укрупненного
направления
подготовки
program_code
string
Код программы
Да
Код направления
09.03.04
подготовки
160
Обязательн
Название
Тип
Ограничения
Описание
Пример
ое
education_form
string
INTRAMURAL,
Да
Форма образования:
INTRAMURAL
PART_TIME,
INTRAMURAL -
EXTRAMURAL
очная,
PART_TIME - очно-
заочная,
EXTRAMURAL -
заочная
education_mod
string
INTRAMURAL,
Да
Режим обучения:
REMOTE
e
MIXED,
INTRAMURAL -
REMOTE
очный,
MIXED - смешанный,
REMOTE -
дистанционный
hours
float
Больше или
Да
Объем программы в
55.0
равно 0
академических часах
credits
float
Больше или
Нет
Объем программы в
5.0
равно 0
зачетных единицах
document_type
string
CERTIFICATE,
Нет, если
Тип выдаваемого
CERTIFICATE
DIPLOMA,
заполнено
документа:
ACKNOWLED
issued_docu
CERTIFICATE -
GEMENT,
ments
сертификат,
CERTIFICATE_
DIPLOMA - диплом,
OF_TRAINING
ACKNOWLEDGEME
NT - удостоверение,
CERTIFICATE_OF_TR
AINING - справка об
обучении
issued_docume
string
Нет, если
Информация о
В результате
nts
заполнено
выдаваемых
успешного окончания
document_ty
документах
обучения выдаётся
pe
диплом.
started_at
string
yyyy-MM-dd
Да
Дата начала
2024-10-10
программы ДПО
finished_at
string
yyyy-MM-dd
Да
Дата окончания
2025-01-01
программы ДПО
duration
string
Нет
Длительность
Продолжительность
программы ДПО
программы - 1 год.
nearest_start_d
string
Нет
Информация о дате
Программа стартует
ate_info
ближайшего старта
каждую осень.
image_url
string
URL
Да
Ссылка на
изображение
программы ДПО
site_url
string
URL
Да
Ссылка на сайт
программы ДПО
technical_requi
string
Нет
Описание технических
Доступно
rements
требований
пользователям из сети
интернет, требуется
камера для проведения
дистанционных
занятий
education_circu
string
Нет
Условия обучения
Обучение проходит во
mstances
второй половине дня
region
string
Да
Адрес
Санкт-Петербург
city
string
Да
местонахождения
Санкт-Петербург
address
string
Да
программы ДПО
Кронверкский пр-кт,
(регион, город, адрес)
49
skills
Список
Нет
Входные требования
объектов типа
(требуемые навыки) по
«Навыки»
коду компетенций
161
Обязательн
Название
Тип
Ограничения
Описание
Пример
ое
student_entranc
string
Нет
Входные требования к
Необходимо быть
e_requirements
обучающемуся в
уверенным
свободной форме
пользователем ПК.
formed_compet
Список
Коды проф.
Да
Перечень
encies
объектов типа
стандартов
формируемых в рамках
«Формируемые
программы
компетенции»
компетенций
instruction_lan
string
Нет
Язык обучения
Русский
guage
study_plan
Список
Нет
Описание
объектов типа
студенческого плана
«Учебный
программы ДПО
план»
teachers
Список
Да
Описание
объектов типа
преподавателей
«Преподаватель
программы ДПО
»
price
float
Больше или
Да
Стоимость
1000.0
равно 0
прохождения
программы в рублях
payment_requir
string
Нет
Описание порядка
Безналичная оплата
ement
оплаты
образовательной
услуги
version
string
Уникальный в
Да
Версия программы
1
рамках
программы
organizer_glob
string
Да
Глобальный ID
691f164f-c425-47f4-
al_id
организации-
add0-bd10a036bc76
правообладателя
(организации,
публикующей данную
программу)
edu_platform_g
string
Нет
Глобальный ID
531f164f-c425-47f4-
lobal_id
образовательной
hrd0-bd10a036bc76
платформы, если
программы ДПО
проходит на платформе
и эта платформа
подключена к ГИС
СЦОС
statistics
Список
Нет
Статистика по
объектов типа
количеству
«Статистика»
обучающихся за
последние годы
online_courses
Список string
Нет
Список глобальных
8942d11f54e64487899a
идентификаторов
3133bdb41b67,
онлайн курсов,
54dd8613-a5d4-4b75-
которые включены в
b2a9-6caecc112076
программу ДПО (если
таковые имеются)
6.1.2.2. Объект “Навыки”
Ограни
Обязате
Название
Тип
Описание
Пример
чения
льное
professional_standar
string
Код
Да
Код профессионального
06.013
d_code
стандар
стандарта
та
162
Ограни
Обязате
Название
Тип
Описание
Пример
чения
льное
labour_function_cod
string
Код
Да
Код трудовой функции
A/03.3
e
функци
и
required_skill
string
Да
Описание требуемого
Программирование
навыка
required_knowledge
string
Да
Описание требуемых
Java 8 и выше
знаний
6.1.2.3. Объект “Формируемые компетенции”
Название
Тип
Ограничения
Обязательное
Описание
Пример
professional_st
string
Код стандарта
Да
Код профессионального
06.013
andard_code
стандарта
labour_functio
string
Код функции
Да
Код трудовой функции
A/03.3
n_code
6.1.2.4. Объект “Учебный план”
Ограничени
Обязате
Название
Тип
Описание
Пример
я
льное
number
integer
Больше или
Да
Номер раздела учебного
1
равно 0
плана
name
string
Да
Название раздела
Введение
учебного плана
modules
Список объектов
Да
Описание модулей
типа “Модуль
раздела учебного плана
учебного плана”
6.1.2.5. Объект “Модуль учебного плана”
Название
Тип
Ограничения
Обязательное
Описание
Пример
number
integer
Больше или равно 0
Да
Номер модуля
1
name
string
Да
Название модуля
Основные понятия
6.1.2.6. Объект “Преподаватель”
Ограничен
Обязате
Название
Тип
Описание
Пример
ия
льное
sort_order
integer
Больше или
Нет
Порядок при сортировке
1
равно 0
преподавателей
full_name
string
Да
Полное ФИО
Иванов Иван Иванович
преподавателя
position
string
Нет
Должность
Преподаватель практики
merit
string
Нет
Регалии
Действительный Член
академии проблем
качества РФ
image_url
string
URL
Нет
Ссылка на изображение
преподавателя
6.1.2.7. Объект «Статистика»
Название
Тип
Ограничения
Обязательное
Описание
Пример
year
integer
yyyy
Да
Год, для которого описана
2023
статистика
163
Название
Тип
Ограничения
Обязательное
Описание
Пример
listeners
integer
Больше или
Да
Количество слушателей,
100
равно 0
прошедших обучение по
программе ДПО в указанный
год
6.1.2.8. Объект “Смена статуса”
Ограничен
Обязател
Название
Тип
Описание
Пример
ия
ьное
global_id
string
Да
Идентификатор программы
957c81f9-68d1-4f1a-
ДПО
8a8b-d08914956fe4
status
string
ACTIVE,
Да
Статус программы ДПО:
ARCHIVED
ARCHIVED
ACTIVE - активная,
ARCHIVED - скрытая
6.1.2.9. Объект “Дополнительная информация о программе”
Выводится в ответе на запрос «Получение программы» (раздел 6.1.1.4), если для данной
программы были добавлены отзывы. Отображается вместе с описанием программы [Таблица
6.1.2.1]
Обязате
Название
Тип
Ограничения
Описание
Пример
льное
created_at
string
yyyy-MM-dd
Да
Дата создания
2023-01-01
программы
actual_rating
Объект «Рейтинг»
Нет
Рейтинг программы
ratings
Список объектов
Нет
Список рейтингов
типа «Рейтинг»
программы
feedbacks
Список объектов
Нет
Список отзывов
типа «Отзыв»
status
string
EXPERT_MODERATI
Да
Статус программы
ACTIVE
ON_IN_PROGRESS,
ACTIVE,
ARCHIVED
6.1.2.10. Объект “Рейтинг”
Название
Тип
Ограничения
Обязательное
Описание
Пример
rating
Float
Нет
Значение рейтинга
10.0
rating_date
string
yyyy-MM-dd
Нет
Дата получения
2023-01-01
6.1.2.11. Объект “Отзыв”
Обязате
Название
Тип
Ограничения
Описание
Пример
льное
rated_at
string
yyyy-MM-dd
Нет
Дата оценивания
2023-01-01
user_id
string
Нет
Идентификатор пользователя
123456789
user_email
string
email
Нет
Email пользователя
test@gamil.com
text
string
Нет
Текст отзыва
Мне нравится
164
6.2. Участники программ ДПО
6.2.1. Описание запросов
6.2.1.1. Добавление записи об участии на курс
Запись списка студентов на программу.
При записи студента на существующую, но неактивную запись - запись активируется.
Записать студента на программу повторно невозможно.
Формат
POST /api/v2/additional_education/participation
запроса
Тело запроса
Содержит список JSON объектов записей об участниках программы с подробной
информацией [Таблица 6.2.2.1].
Пример тела
{
запроса
"participation": [
{
"program_global_id": "program_global_id_1",
"enroll_date": "2023-01-01",
"session_id": "id2",
"student sso_id": "student_sso_id_1",
"session_start": "2023-01-01",
"session_end": "2024-01-01",
"group_name": "P3402"
},
{
"program_global_id": "program_global_id_2",
"session_id": "id",
"student_sso_id": "student_sso_id_2"
}
]
}
Возвращаемое
HTTP response status 200 (OK) - Запрос выполнен. В теле ответа список результатов
значение
выполнения запроса [Таблица 6.2.2.2.1] для каждого студента.
HTTP response status 400 (Bad Request) - был принят неверный объект участника
программы или послан неверный запрос.
HTTP response status 403 (Forbidden) - недостаточно прав на добавление: попытка
добавить участника в стороннюю организацию, у пользователя нет прав на
добавление записей об участии.
6.2.1.2. Проверка существования записи об участии
Формат
POST /api/v2/additional_education/participation/check
запроса
Тело запроса
Содержит JSON объект записи об участниках программы [Таблица 6.2.2.1].
Возвращаемое
HTTP response status 200 (OK) - Запрос выполнен. В теле ответа список результатов
значение
проверки на существование [Таблица 6.2.2.3].
HTTP response status 400 (Bad Request) - был принят неверный объект участника
программы или послан неверный запрос.
HTTP response status 403 (Forbidden) - недостаточно прав: попытка просмотреть
участника в сторонней организации, у пользователя нет прав на чтение записей об
участии.
165
6.2.1.3. Удаление записи об участии
Формат
DELETE /api/v2/additional_education/participation
запроса
Тело запроса
Содержит список JSON объектов записей об участниках программы [Таблица
6.2.2.1].
Возвращаемое
HTTP response status 200 (OK) - Запрос выполнен. В теле ответа список результатов
значение
выполнения запроса [Таблица 6.2.2.2.1] для каждого студента.
HTTP response status 400 (Bad Request) - был принят неверный объект участника
программы или послан неверный запрос.
HTTP response status 403 (Forbidden) - недостаточно прав на изменение: попытка
изменить участника из сторонней организации, у пользователя нет прав на
добавление записей об участии.
6.2.2. Описание объектов
6.2.2.1. Объект “Запись об участии с подробной информацией”
Обязат
Название
Тип
Ограничения
Описание
Пример
ельное
program_global_id
string
Global id
Да
Идентификатор
957c81f9-68d1-4f1a-
программы
программы ДПО
8a8b-d08914956fe4
enroll_date
string
yyyy-MM-dd
Нет
Дата записи
2023-01-01
session_id
string
Да
Идентификатор
spring_2023
сессии
student_sso_id
string
SSO id студента
Да
SSO ID студента
d637df21-e8bc-4a72-
9a57-58326e38e360
session_start
string
yyyy-MM-dd
Нет
Дата начала сессии
2023-03-01
session_end
string
yyyy-MM-dd
Нет
Дата окончания
2023-06-01
сессии
group_name
string
Группа в
Нет
Название группы
P3402
программе
для зачисления
6.2.2.2. Объект “Результат выполнения запроса”
Обязат
Название
Тип
Ограничения
Описание
Пример
ельное
program_glob
string
Global id
Да
Идентификатор
957c81f9-68d1-4f1a-
al_id
программы
программы ДПО
8a8b-d08914956fe4
student_sso_id
string
SSO id студента
Да
SSO ID студента
d637df21-e8bc-4a72-
9a57-58326e38e360
result
boolean
Да
Флаг успешного
true
выполнения запроса
status
string
Статус
Да
Конкретизированный
SAVED
выполнения
результат выполнения
[Таблица 2.2.2.2]
или ошибка.
Значения статусов:
Значение
Результат
Описание
SAVED
Оk
Запись на участие сохранена
GROUP_CHANGED
Оk
Группа успешна изменена
DEACTIVATE
Оk
Запись на участие деактивирована
USER_NOT_FOUND
Error
Пользователь не найден по sso id
USER_ALREADY_ENROLLED
Error
Пользователь уже записан на данную программу
PROGRAM_NOT_FOUND
Error
Программа не найдена по global_id
PARTICIPATION_NOT_FOUND
Error
Запись на участие не найдено
166
Значение
Результат
Описание
NOT_ENOUGH_PERMISSIONS
Error
Недостаточно прав
GROUP_NOT_FOUND
Error
Группа не найдена
UNKNOWN_ERROR
Error
Неизвестная ошибка
6.2.2.3. Объект “Результат проверки существования записи об участии”
Ограничен
Обязате
Название
Тип
Описание
Пример
ия
льное
program_gl
string
Global id
Да
Идентификатор программы
957c81f9-68d1-4f1a-
obal_id
программы
ДПО
8a8b-d08914956fe4
student_sso
string
SSO id
Да
SSO ID студента
d637df21-e8bc-4a72-
_id
студента
9a57-58326e38e360
enroll
boolean
Да
Флаг результата проверки
true
6.2.2.4. Объект “Запись об участии”
Обязате
Название
Тип
Ограничения
Описание
Пример
льное
program_global_id
string
Global id
Да
Идентификатор
957c81f9-68d1-4f1a-
программы
программы ДПО
8a8b-d08914956fe4
session_id
string
Да
Идентификатор сессии
spring_2023
student_sso_id
string
SSO id
Да
SSO ID студента
d637df21-e8bc-4a72-
студента
9a57-58326e38e360
6.3. Документы ДПО
6.3.1. Описание запросов
6.3.1.1. Загрузка документа повышения квалификации
Загрузка документа повышения квалификации.
Формат
POST /api/v2/additional_education/documents
запроса
Тело запроса
Содержит multipart запрос с документом и описанием [Таблица 6.3.2.1]
Возвращаемое
HTTP response status 200 (OK) - Документ успешно сохранен.
значение
HTTP response status 400 (Bad Request) - был принят неверный объект документа
или послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на добавление документа:
попытка добавить документ в стороннюю организацию, у пользователя нет прав на
добавление документа.
6.3.1.2. Получение информации о документе по id
Формат
GET /api/v2/additional_education/documents?document_id={document_id}
запроса
Возвращаемое
HTTP response status 200 (OK) - В теле документа содержится объект типа
значение
“Описание документа” с дополнительными полями owner_email и owner_name
HTTP response status 400 (Bad Request) - был принят неверный объект документа
или послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на добавление документа:
попытка чтения документа из сторонней организации, у пользователя нет прав на
чтение документа.
167
6.3.1.3. Получение информации о документе по id
Формат
GET
запроса
/api/v2/additional_education/documents?user_id={user_id}&type={type}&program_id={
program_id}&from={from}&to=to
Параметры
user_id - sso_id пользователя (обязательное)
запроса
type - тип документа (необязательное)
program_id - ID документа (необязательное)
from - дата “от” (необязательное)
to - дата “до” (необязательное)
Возвращаемое
HTTP response status 200 (OK) - В теле документа содержится объект типа
значение
“Описание документа” с дополнительными полями owner_email и owner_name
HTTP response status 400 (Bad Request) - был послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на добавление документа:
попытка чтения документа из сторонней организации, у пользователя нет прав на
чтение документа.
6.3.1.4. Скачивание документа в формате PDF
Формат
GET /api/v2/additional_education/documents/download?document_id={document_id}
запроса
Возвращаемое
HTTP response status 200 (OK) - Документ в формате документ
значение
HTTP response status 400 (Bad Request) - был послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на добавление документа:
попытка чтения документа из сторонней организации, у пользователя нет прав на
чтение документа.
6.3.2. Описание объектов
6.3.2.1. Multipart запроса документа
Название
Тип
Ограничения
Обязательное
Описание
Пример
document
file
PDF
Да
Документ в формате
PDF
description
Объект типа
Да
Описание документа
«Описание
документа»
6.3.2.2. Объект “Описание документа”
Обязат
Название
Тип
Ограничения
Описание
Пример
ельное
registration_number
string
Нет
Регистрационный
123456789
номер документа
city
string
Нет
Город, указанный в
Москва
документе
168
Обязат
Название
Тип
Ограничения
Описание
Пример
ельное
type
string
CERTIFICATE,
Нет
Тип документа:
CERTIFICATE
DIPLOMA,
CERTIFICATE -
ACKNOWLED
сертификат,
GEMENT,
DIPLOMA -
CERTIFICATE
диплом,
_OF_TRAININ
ACKNOWLEDGEM
G
ENT -
удостоверение,
CERTIFICATE_OF_
TRAINING -
справка об
обучении
program_global_id
string
Да
Идентификатор
957c81f9-68d1-
программы ДПО
4f1a-8a8b-
d08914956fe4
owner_sso_id
string
Да
SSO ID владельца
d637df21-e8bc-
документа
4a72-9a57-
58326e38e360
document_number
string
Нет
Номер документа
987654321
issue_date
string
yyyy-MM-dd
Нет
Дата выдачи
2023-02-02
документа
participation
Объект
Да
Участник, которому
«Запись
выдан документ
об
участии»
[Таблица
2.3.3]
6.4. Группы ДПО
6.4.1. Описание запросов
6.4.1.1. Добавление группы
Формат
POST /api/v2/additional_education/groups
запроса
Тело запроса
Содержит JSON объект типа “Группа” [Таблица 6.4.2.1]
Возвращаемое
HTTP response status 200 (OK) - Группа успешно сохранена
значение
HTTP response status 400 (Bad Request) - был принят неверный объект документа
или послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на добавление группы:
попытка добавить группу в стороннюю организацию, у пользователя нет прав на
добавление группы.
169
6.4.1.2. Запись студентов в группу
Формат
POST /api/v2/additional_education/groups/participations
запроса
Тело запроса
Содержит JSON объект типа “Запись в группу” [Таблица 6.4.2.2]
Возвращаемое
HTTP response status 200 (OK) - Группа успешно удалена
значение
HTTP response status 400 (Bad Request) - был принят неверный объект документа
или послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на добавление группы:
попытка добавить группу в стороннюю организацию, у пользователя нет прав на
добавление группы.
6.4.1.3. Удаление группы
Удаление доступно только для пустой группы
Формат
DELETE /api/v2/additional_education/groups
запроса
Тело запроса
Содержит JSON объект типа “Группа” [Таблица 6.4.2.1]
Возвращаемое
HTTP response status 200 (OK) - Группа успешно удалена
значение
HTTP response status 400 (Bad Request) - был послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на удаление группы:
попытка удалить группу из сторонней организации, у пользователя нет прав на
изменение группы.
6.4.1.4. Просмотр слушателей группы
Формат
GET /api/v2/additional_education/groups
запроса
Тело запроса
Содержит JSON объект типа “Группа” [Таблица 6.4.2.1]
Возвращаемое
HTTP response status 200 (OK) - В теле ответа объект типа “Слушатели группы”
значение
HTTP response status 400 (Bad Request) - был принят неверный объект документа
или послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на чтение группы:
попытка получить группу из сторонней организации, у пользователя нет прав на
чтение группы.
6.4.1.5. Удаление слушателей из группы
Формат
POST /api/v2/additional_education/groups/participation/remove
запроса
170
Тело запроса
Содержит список объектов типа “Запись об участии” [Таблица 6.4.2.3]
Пример тела
{
запроса
"participation": [
{
"program_global_id": "program_global_id_1",
"session_id": "id2",
"student_sso_id": "student_sso_id_1"
},
{
"program_global_id": "program_global_id_2",
"session_id": "id2",
"student_sso_id": "student_sso_id_2"
}
]
}
Возвращаемо
HTTP response status 200 (OK) - В теле список объектов “Результат выполнения
е значение
запроса” [Таблица 6.4.2.2]
HTTP response status 400 (Bad Request) - был принят неверный объект документа или
послан неверный запрос
HTTP response status 403 (Forbidden) - недостаточно прав на чтение группы: попытка
получить группу из сторонней организации, у пользователя нет прав на чтение
группы.
6.4.2. Описание объектов
6.4.2.1. Объект группы
Обязате
Название
Тип
Ограничения
Описание
Пример
льное
name
string
Уникальное в рамках
Да
Название
P3402
программы
группы
program_global_id
string
Да
Идентификатор
87d24443-8f07-
программы
416c-8ae8-
d85d6423161f
6.4.2.2. Объект “Слушатели группы”
Ограни
Обязатель
Название
Тип
Описание
Пример
чения
ное
group
Объект типа «Группа»
Да
Описание группы
participations
Список объектов типа
Да
Описание записей на
«Запись в группу»
участие для добавления в
группу
6.4.2.3. Объект “Запись в группу”
Обязате
Название
Тип
Ограничения
Описание
Пример
льное
enroll_date
string
yyyy-MM-dd
Нет
Дата записи
2023-01-01
session_id
string
Да
Идентификатор сессии
spring_2023
student_sso_id
string
SSO id студента
Да
SSO ID студента
d637df21-e8bc-4a72-
9a57-58326e38e360
session_start
string
yyyy-MM-dd
Нет
Дата начала сессии
2023-03-01
session_end
string
yyyy-MM-dd
Нет
Дата окончания сессии
2023-06-01
171
6.5. Заявки на ДПО
6.5.1. Описание запросов
6.5.1.1. Получение списка заявок на обучение по программам ДПО
Формат
GET /api/v2/additional_education/requests
запроса
Параметры
from - Дата, с которой необходимо вернуть изменённые заявки. Передаётся в
запроса
формате ‘yyyy-MM-dd'T'HH:mm:ss’ (необязательное)
page - номер страницы (необязательное). По умолчанию 0. Размер страницы
фиксирован - 50 записей
Возвращаемое
200 OK и JSON следующего вида:
значение
{
“total_pages”: 10, - общее количество страниц
“data”: [] - массив Объектов заявки на обучение по программе ДПО
}
6.5.1.2. Получение заявки на обучение по программам ДПО по идентификатору
Формат
GET /api/v2/additional_education/requests/{id}
запроса
Параметры
id - идентификатор заявки
запроса
Возвращаемое
200 OK и JSON следующего вида:
значение
Объект заявки на обучение по программе ДПО
6.5.2. Описание объектов
6.5.2.1. Объект заявки на обучение по программе ДПО
Обязат
Название
Тип
Ограничения
Описание
Пример
ельное
id
number
Да
Идентификатор заявки
12331223
price
number
Нет
Предварительная
36000.0
стоимость обучения
program_id
string
Да
Идентификатор
d637df21-e8bc-
программы
4a72-9a57-
58326e38e360
provider_id
string
Да
global_id организатора
d637df21-e8bc-
программы
4a72-9a57-
58326e38e360
created_at
string
yyyy-MM-
Да
Дата и время создания
2023-01-
dd'T'HH:mm:ss
заявки
19T21:00:00Z
updated_at
string
yyyy-MM-
Да
Дата и время
2023-01-
dd'T'HH:mm:ss
модификации заявки
19T21:00:00Z
status
string
CREATED,
Да
Статус заявки:
CREATED
ACCEPTED,
CREATED - создана,
REJECTED,
ACCEPTED - принята,
REVOKED
REJECTED - отклонена,
REVOKED - отозвана
172
Обязат
Название
Тип
Ограничения
Описание
Пример
ельное
type
string
PERSONAL,
Да
Тип заявки:
PERSONAL
ORGANIZATION
PERSONAL - от физ.
лица,
ORGANIZATION - от
организации
applicant_id
string
Да
Идентификатор
2497e5ab-45b0-
заказчика:
44c1-8db3-
В случае PERSONAL
b6726f56bfc9"
заявки - user_id
пользователя.
В случае
ORGANIZATION
заявки - global_id
организации
previous_re
number
Нет
Идентификатор
12331223
quest_id
предыдущей заявки,
в случае изменения
состава участников
relevant
boolean
Да
Признак актуальности
заявки. В случае
изменения состава
участников имеет
значение false.
participants
Массив
Да
Список участников
объектов
участников
обучения
6.5.2.2. Объект участника обучения
Обязате
Название
Тип
Ограничения
Описание
Пример
льное
user_id
string
Да
Идентификатор
2497e5ab-45b0-
44c1-8db3-
b6726f56bfc9"
status
string
ACCEPTED,
Нет
Статус согласия пользователя
36000.0
REJECTED
на участие в данной заявке.
null - решение не принято,
ACCEPTED - заявка принята,
REJECTED - заявка
отклонена
173