содержание      ..      1       2         ..

Описание программных интерфейсов государственной информационной системы «Современная цифровая образовательная среда» (Версия 2.8.5) - часть 1

Термины, определения и сокращения

Термин, сокращение

Определение

ГИС

Государственная информационная система

ГИС СЦОС

Государственная информационная система «Современная цифровая

(ранее Портал СЦОС)

образовательная среда», размещённая в информационно-

телекоммуникационной сети «Интернет» по адресу online.edu.ru

REST API

Согласованный набор ограничений, учитываемых

при проектировании распределенной гипермедиа-системы

URL

Единый указатель ресурса

Блокчейн (blockchain)

Выстроенная по определённым правилам непрерывная

последовательная цепочка блоков, содержащих информацию.

Чаще всего копии цепочек блоков хранятся и независимо друг

от друга обрабатываются на множестве разных узлов

ДПО

Дополнительное профессиональное образование

ЕСИА

Единая система идентификации и аутентификации

ИС

Информационная система

Образовательная

Комплекс основных характеристик образования (объем,

программа (ОП)

содержание, планируемые результаты), организационно-

педагогических условий и в случаях, предусмотренных

Федеральным законом от 29.12.2012 № 273-ФЗ «Об образовании

в Российской Федерации», форм аттестации, который представлен

в виде учебного плана, календарного учебного графика, рабочих

программ учебных предметов, курсов, дисциплин (модулей), иных

компонентов, а также оценочных и методических материалов

Онлайн-курс (ОК)

Реализуемая с применением исключительно электронного обучения,

дистанционных образовательных технологий структурированная

совокупность видов, форм и средств образовательной деятельности,

обеспечивающая достижение и объективную оценку определенных

результатов обучения на основе комплекса электронных

образовательных ресурсов, размещенных в электронной

информационно-образовательной среде, к которой предоставляется

доступ через информационно-телекоммуникационную сеть

«Интернет»

Онлайн-обучение

Целенаправленная познавательная деятельность людей,

реализуемая с применением онлайн-курсов

5

Термин, сокращение

Определение

ООВО

Образовательная организация высшего образования

Паспорт (описание)

Описание онлайн-курса в ГИС СЦОС по установленной форме,

онлайн-курса (паспорт

содержащее в себе сведения, характеризующие онлайн-курс

ОК)

по различным параметрам и позволяющие пользователю получить

необходимую информацию для выбора онлайн-курса

Платформа онлайн-

Совокупность программных и технических средств, реализующих

обучения (ПОО)

функции системы управления обучением и позволяющих размещать

в открытом или закрытом доступе в сети Интернет онлайн-курсы

Пользователь ГИС

Лицо, осуществившее вход в ГИС СЦОС как по результатам

СЦОС (пользователь)

процедуры авторизации, так и без нее

Программные

Набор функций (сервисов), предоставляемый ГИС СЦОС

интерфейсы (API)

информационным системам пользователей и участников

ГИС СЦОС, для автоматического (без участия человека)

взаимодействия с ГИС СЦОС, включая загрузку и выгрузку данных,

предусмотренных регламентами ГИС СЦОС.

Реестр онлайн-курсов

Программные решения, обеспечивающие хранение и передачу

(РОК)

данных об онлайн-курсах, включая паспорт онлайн-курса,

информацию об оценках и рецензиях на онлайн-курсы

Слушатель онлайн-

Физическое лицо, прошедшее регистрацию в ГИС СЦОС, которое

курса (слушатель ОК)

приступило к освоению онлайн-курса

Технология единого

Технология поддержания сессии пользователя на портале

входа (Single Sign-On,

при переходе между его разделами без повторной аутентификации

SSO)

Цифровое портфолио

Программные решения, обеспечивающие хранение и передачу

данных о персональных достижениях (результатах обучения)

обучающегося при освоении онлайн-курсов, включая электронный

сертификат об освоении онлайн-курса и информацию о результатах

текущей аттестации в рамках онлайн-курса

ЭДО

Электронный документооборот

DELETE

Запрос, использующийся для удаления указанного ресурса

GET

Запрос, использующийся для запроса содержимого указанного

ресурса

JSON

Текстовый формат обмена данными

6

1.2. Пример описания интерфейсов в соответствии с указанными

принципами

Получение списка записей о трудоустройстве пользователя по идентификатору пользователя

Формат запроса

GET /api/v1/careers?user_id={user_id}

Входные данные

user_id - идентификатор пользователя в СЦОС

Возвращаемое

HTTP response status 200 (Ok) и массив записей о трудоустройстве

значение

HTTP response status 404 (Not Found) в случае отсутствия записей

для пользователя с таким ID

Объект записи о трудоустройстве

Название поля

Тип

Ограничение

Обязательное

Описание

id

long

Да

Идентификатор

записи

о трудоустройстве

user_id

string

Да

ID пользователя

position_name

string

Да

Должность

organization_name

string

Да

Название

организации

start_date

date

yyyy-MM-dd

Да

Дата начала

работы

end_date

date

yyyy-MM-dd

Нет

Дата окончания

работы

1.3. Общий механизм авторизации запросов к API

Авторизация запросов на API происходит следующим образом. Для всех поступающих

запросов прокси-сервер определяет наличие ключа в поле заголовка X-CN-UUID и выставляет

следующие поля:

- X-Proxy-Forwarded-SSL с возможными значениями:Success - в запросе присутствует

заголовок X-CN-UUID с ключом, NONE - если таковой отсутствует;

- X-Proxy-Forwarded-CN со значением CN=<identifier>. Выставляется в случае наличия

ключа в запросе и содержит в себе идентификатор системы, осуществляющей запрос.

Для проверки прав системы и валидности указанного идентификатора следует использовать

следующий API.

Формат запроса

GET https://online.edu.ru/api/v2/permissions?identifier=<identifier>

Входные данные

identifier - идентификатор системы

Возвращаемое

HTTP response status 404 (NOT FOUND) - в случае, если система с таким

значение

идентификатором не найдена

HTTP response status 200 (OK) и объект ответа на запрос списка прав

Объект ответа на запрос списка прав

Название

Тип

Обязательное

Описание

identifier

string

Да

Идентификатор системы

global_id

string

Нет

Идентификатор организации, к которой привязана

система. Если таковая имеется.

9

2. Система идентификации и аутентификации

2.1. Получение конфигураций OpenID Connect

Основной конечной точкой для получения конфигураций OpenID Connect является well-known.

В ней перечислены все прочие конечные точки и другие параметры конфигурации, относящиеся

к реализации OpenID Connect в Провайдере авторизации.

Некоторые библиотеки и реализации стандарта, извлекают все необходимые параметры из

точки well-known и не требуют указания остальных конечных точек и специфичных параметров

сервера идентификации. Соответствует спецификации Provider Configuration Information.

Формат запроса

GET /realms/{имя домена}/.well-known/openid-configuration

Пример

curl "https://auth.online.edu.ru/realms/portfolio/.well-known/openid-

configuration"

2.1.1. Формат ответа

Огран

Обязат

Название

Тип

Описание

Пример

ичения

ельное

issuer

string

URL

Да

URL-адрес домена

https://auth.online.edu.ru/real

программы

ms/portfolio

authorization_e

string

URL

Да

URL-адрес сервиса

https://auth.online.edu.ru/real

ndpoint

аутентификации

ms/portfolio/protocol/openid-

домена программы

connect/auth

token_endpoint

string

URL

Да

URL-адрес сервиса

https://auth.online.edu.ru/real

получения токена

ms/portfolio/protocol/openid-

домена программы

connect/token

token_introspec

string

URL

Да

URL-адрес сервиса

https://auth.online.edu.ru/real

tion_endpoint

получения

ms/portfolio/protocol/openid-

информации

connect/token/introspect

о состоянии токена

домена программы

userinfo_endpoi

string

URL

Да

URL-адрес сервиса

https://auth.online.edu.ru/real

nt

получения данных

ms/portfolio/protocol/openid-

пользователя

connect/userinfo

домена программы

end_session_en

string

URL

Да

URL-адрес сервиса

https://auth.online.edu.ru/real

dpoint

завершения сессии

ms/portfolio/protocol/openid-

домена программы

connect/logout

jwks_uri

string

URL

Да

URL-адрес сервиса

https://auth.online.edu.ru/real

получения

ms/portfolio/protocol/openid-

информации о

connect/certs

сертификатах

домена программы

grant_types_su

string[]

Да

Список

["authorization_code"]

pported

поддерживаемых

потоков доменом

программы

11

"public"

],

"id_token_signing_alg_values_supported": [

"RS256"

],

"response_modes_supported": [

"query",

"fragment",

"form_post"

],

"registration_endpoint": "https://auth.online.edu.ru/realms/portfolio/clients/openid-connect"

}

2.2. Точка авторизации (Authorization Endpoint)

Конечная точка авторизации выполняет аутентификацию пользователя. Это делается путем

редиректа запроса на эту конечную точку. После успешной аутентификации будет совершен

редирект обратно в приложение. Соответствует спецификации Authorization Endpoint.

Формат

GET /realms/{имя домена}/protocol/openid-connect/auth

запроса

Пример

curl "https://auth.online.edu.ru/realms/portfolio/protocol/openid-

connect/auth?response_type=code&client_id=security-admin-

console&redirect_uri=https%3A%2F%2Fauth.online.edu.ru%2Fwebadmin%2Findex.xhtml"

2.3. Получение токена (Token Endpoint)

Конечная точка используется для получения токенов. Токены могут быть получены путем

обмена авторизационным кодом или путем предоставления учетных данных в зависимости

от того, какой поток используется. Конечная точка маркера также используется для получения

новых токенов доступа, когда они истекают. Соответствует спецификации Token Endpoint.

Формат запроса

POST /realms/{имя домена}/protocol/openid-connect/token

Пример запроса

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d

для получения токена

'grant_type=authorization_code&client_id=test-oidc&client_secret=5e696197-

путем предоставления

7287-417d-b87d-8cfde60c9068&code=bc295886-f854-11ec-b939-

учетных данных Client

0242ac120002&redirect_uri=https://online.edu.ru/login/complete'

Credentials Grant:

"https://auth.online.edu.ru/realms/portfolio/protocol/openid-connect/token"

2.3.1. Формат ответа

Ограни

Обязате

Название

Тип

Описание

Пример

чения

льное

access_token

string

Да

Токен доступа

eyJhbGciOiJSUzI1NiJ9

…Fy9xbHegg

expires_in

integer

≥ 0

Да

Время жизни токена

60

доступа

refresh_expires_in

integer

≥ 0

Да

Время жизни токена

1800

обновления

refresh_token

string

Токен обновления

eyJhbGciOiJSUzI1NiJ9

Да

…f930lA5csMjL7aQ

token_type

string

Да

Тип токена

bearer

13

Ограни

Обязате

Название

Тип

Описание

Пример

чения

льное

id_token

string

Да

Токен идентификации

eyJhbGciOiJSUzI1NiJ9

…Iul5jjIzkOD8Xvijp4y

Q

not-before-policy

integer

≥ 0

Да

Дата последнего входа

1471337167

session_state

Да

Параметр State

b2e673b5-6cb5-4f0d-

8ebe-24bf21485872

2.3.2. Пример ответа

{

"access_token": "eyJhbGciOiJSUzI1NiJ9…Fy9xbHegg",

"expires_in": 60,

"refresh_expires_in": 1800,

"refresh_token": "eyJhbGciOiJSUzI1NiJ9…f930lA5csMjL7aQ",

"token_type": "bearer",

"id_token": "eyJhbGciOiJSUzI1NiJ9…Iul5jjIzkOD8Xvijp4yQ",

"not-before-policy": 1471337167,

"session_state": "b2e673b5-6cb5-4f0d-8ebe-24bf21485872"

}

2.4. Информация о пользователе (Userinfo Endpoint)

Конечная точка возвращает стандартные параметры аутентифицированного пользователя и

защищается bearer токеном. Соответствует спецификации Userinfo Endpoint.

Формат

GET /realms/{имя домена}/protocol/openid-connect/userinfo

запроса

Пример

curl -d access_token=Bearer eyJhbGciOiJSUzI1NiJ9…mk_4xFy9xbHegg

"https://auth.online.edu.ru/realms/portfolio/protocol/openid-connect/userinfo"

2.4.1. Формат ответа

Ограни

Обязат

Название

Тип

Описание

Пример

чения

ельное

sub

string

Да

Идентификатор пользователя в

acd969f9-7fe1-4230-

программе

b572-aa2c0d9b7009

name

string

Да

Полное имя пользователя

Имя Отчество

Фамилия

preferred_user

string

Да

Логин пользователя

user

name

middle_name

string

Отчество пользователя

Отчество

given_name

string

Да

Имя пользователя

Имя

family_name

string

Да

Фамилия пользователя

Фамилия

email

string

email

Да

Адрес электронной почты

alekseev-

пользователя

matvej1@mail.ru

14

2.4.2. Пример ответа

{

"sub": "acd969f9-7fe1-4230-b572-aa2c0d9b7009",

"name": "Имя Отчество Фамилия",

"preferred_username": "user",

"middle_name": "Отчество",

"given_name": "Имя",

"family_name": "Фамилия",

"email": "alekseev-matvej1@mail.ru"

}

2.5. Выход из системы (Logout Endpoint)

Конечная точка выхода пользователя из системы. Выход выполняется путем редиректа

запроса на конечную точку, и в этом случае активный сеанс пользователя будет завершен. После

этого будет совершен редирект обратно в приложение. Конечная точка также может быть

вызвана непосредственно приложением. Чтобы вызвать эту конечную точку, необходимо

включить токен обновления (refresh token), а также учетные данные, необходимые

для аутентификации системы.

Формат запроса

GET /realms/{имя домена}/protocol/openid-connect/logout

Пример

curl "https://auth.online.edu.ru/realms/portfolio/protocol/openid-connect/logout"

2.6. Получение ключей (Certificate Endpoint)

Конечная точка возвращает открытые ключи, в рамках домена, закодированные как JSON Web

Key (JWK). Служит для валидации токена. Соответствует спецификации JSON Web Key

specification.

Формат запроса

GET /realms/{имя домена}/protocol/openid-connect/certs

Пример

curl "https://auth.online.edu.ru/realms/portfolio/protocol/openid-connect/certs"

2.6.1. Формат ответа

Назва

Ограни

Обязате

Тип

Описание

Пример

ние

чения

льное

kid

string

Да

Параметр используется для соответствия

rWbuSBhwBOOR_BtzDiH

определенному ключу

v6_6ECN1qfwE8J96gIPtE

6Fo

kty

string

Да

Параметр идентифицирует семейство

RSA

криптографического алгоритма ключа

alg

string

Да

Параметр идентифицирует

RSA256

криптографический алгоритм ключа

use

string

Параметр определяет предполагаемое

sig

Да

использование открытого ключа sig -

подпись.

n

string

Да

Параметр, содержащий модуль и

yJdXqJ8lU8qlTP0fuPu…_

совместно с параметром “e”

giOnzw

образующий открытую часть ключа

e

string

Да

Параметр, содержащий значение

AQAB

открытой экспоненты

15

2.6.2. Пример ответа

{

"keys": [

{

"kid": "rWbuSBhwBOOR_BtzDiHv6_6ECN1qfwE8J96gIPtE6Fo",

"kty": "RSA",

"alg": "RS256",

"use": "sig",

"n": "yJdXqJ8lU8qlTP0fuPu…_giOnzw",

"e": "AQAB"

}

]

}

2.7. Извлечение активного состояния токена (Introspection

Endpoint)

Формат

POST /realms/{имя домена}/protocol/openid-connect/token/introspect

запроса

curl -X POST \

https://auth.online.edu.ru/realms/portfolio/protocol/openid-connect/token/introspect \

Пример

-H 'content-type: application/x-www-form-urlencoded' \

-d 'grant_type=password&client_id=<Идентификатор системы>&client_secret=<Секретный

ключ системы>&token=<access_token/refresh_token>'

Конечная точка интроспекции используется для извлечения активного состояния токена.

Может использоваться только в confidential режиме. Соответствует спецификации OAuth 2.0

Token Introspection specification.

2.8. Информация о пользователе

2.8.1. Получение идентификатора пользователя по email

2.8.1.1. Запрос

Формат запроса

GET

https://online.edu.ru/api/v2/users/id?email=<email>

2.8.1.2. Параметры запроса

Параметр

Тип

Описание

Пример

email

string

email пользователя

example@online.edu.ru

2.8.1.3. Ответы

Статус

Описание

200

JSON c идентификатором пользователя

{

"user_id": "730e4f8c-4c96-4ea6-9d2a-86338eca7de8"}

404

Not found

16

3. Реестр онлайн-курсов

3.1. Онлайн курсы, платформы онлайн-обучения, правообладатели

3.1.1. Объект данных для публикации онлайн курса

Обязат

Название

Тип

Ограничения

Описание

Пример

ельное

title

string

Длина от 1 до 255.

Да

Название онлайн-

Ядерная физика

курса

started_at

string

Дата в формате:

Да

Дата ближайшего

2022-09-30

YYYY-MM-DD

запуска

finished_at

string

Дата в формате:

Нет

Дата окончания

2022-12-31

YYYY-MM-DD

онлайн-курса

enrollment_fi

string

Дата в формате

Нет

Дата окончания

2022-11-10

nished_at

YYYY-MM-DD

записи на онлайн-

курс

image

string

URL

Да

Ссылка на

https://online.edu.ru/stat

изображение

ic/courses/i/01.01/cours

e/11.jpg

description

string

Да

Описание онлайн-

Ядерная физика

курса

является одним из

основных разделов

физики, связанных с

описанием свойств

материи.

competences

string

Да

Строка с набором

Компетенция 1 \n

компетенций. Для

Компетенция 2

разделения строк

по позициям

необходимо

использовать \n

requirements

string[]

Да

Массив строк -

входных

требований к

обучающемуся

content

string

Да

Содержание

<ul><li>Модуль 1.

онлайн-курса

Общие свойства

ядер</li></ul>

external_url

string

URL

Да

Ссылка на онлайн-

https://openedu.ru/cours

курс на сайте

e/spbu/PHYSNU/

Платформы

direction

string[]

Да

Массив

идентификаторов

направлений в

формате:

“01.01.06”

institution

string

Да

Идентификатор

50150411-3ae5-4b51-

Правообладателя

a4b3-0511a2fa02bd

duration

Объект

Да

Длительность

{

длительн

онлайн-курса

"code": "week",

ости

в неделях

"value": 5

(CourseD

}

uration)

17

Обязат

Название

Тип

Ограничения

Описание

Пример

ельное

lectures

integer

> 0

Нет

Количество

12

лекций

language

string

Двухбуквенный

Нет

Язык онлайн-курса

ru

код

cert

string

true\false

Да

Возможность

"true"

получить

сертификат

visitors

integer

≥ 0

Нет

Количество

234

записей на сессию

онлайн-курса

teachers

teacher[]

Да

Массив лекторов.

См. ниже

transfers

course_tra

Нет

Массив

nsfer[]

перезачётов.

См. ниже

results

string

Да

Результаты

обучения

accreditated

string

Нет

Аккредитация

Яндекс

hours

integer

Нет

Объем онлайн-

72

курса, в часах

hours_per_w

integer

Нет

Требуемое время

5

eek

для изучения

онлайн-курса,

часов в неделю

business_ver

string

Да

Версия курса

1

sion

promo_url

string

Нет

Ссылка на

https://example.com/idb

проморолик

cb.avi

promo_lang

string

Нет

Язык проморолика

ru

subtitles_lan

string

Нет

Язык субтитров

en

g

estimation_to

string

Нет

Оценочные

Прокторинг

ols

средства

proctoring_s

string

Нет

Используемый

Examus

ervice

сервис

прокторинга (либо

перечень сервисов

через “,”)

sessionid

string

Нет

идентификатор

bhjdcbhjdb893278sdjhb

сессии курса на

c

платформе

credits

number

Да

Трудоёмкость

5

курса в з.е.

proctoring_ty

string

Допустимые

Нет

Тип(-ы)

асинхронный

pe

значения:

используемого(-

“синхронный”,

ых) сервиса(-ов)

“асинхронный”

прокторинга (либо

перечень через “,”)

assessment_d

string

Нет

Текстовое

escription

описание системы

оценивания

(критерии и шкалы

оценивания)

18

3.1.2. Объект лектора

Поля объекта teacher

Обязат

Название

Тип

Ограничения

Описание

Пример

ельное

display_name

string

Длина от 1 до

ФИО лектора

Иванов Иван Иванович

Да

255

image

string

URL

Ссылка

https://online.edu.ru/static/co

Да

на изображение

urses/i/01.01/rating/2.jpg

лектора

description

string

Описание лектора

Кандидат педагогических

Нет

наук, доцент.

3.1.3. Объект перезачёта

Поля объекта course_transfer

Название

Тип

Обязательное

Описание

Пример

institution_id

string

Да

Идентификатор учебного

50150411-3ae5-4b51-

заведения

a4b3-0511a2fa02bd

direction_id

string

Да

Идентификатор направления

123

3.1.4. Объект длительности

Поля объекта CourseDuration

Название

Тип

Обязательное

Описание

Пример

code

string

Да

Код вида длительности (week)

week

value

integer

Да

Длительность курса в неделях

5

3.1.5. Добавление онлайн-курса

3.1.5.1. Размещение онлайн-курса

Размещение онлайн-курса в ГИС СЦОС возможно только после подачи заявки

от правообладателя через личный кабинет с указанием платформы онлайн обучения, названия

курса, ссылки на курс на сайте платформы.

После подачи заявки правообладателем, она отображается в личном кабинете платформы

онлайн образования и появляется возможность загрузить данный курс в ГИС СЦОС

через соответствующий API (поле external_url должно полностью совпадать со ссылкой на курс,

указанной в заявке.)

После загрузки курса в реестр заявка переходит к координатору, который должен назначить

эксперта для проведения обязательной экспертизы.

Эксперту в личном кабинете доступна обработка соответствующей заявки. Он должен

заполнить форму экспертизы, после чего заявка возвращается координатору, который

на основании проведенной экспертизы принимает решение о публикации курса в реестре.

19

При обновлении онлайн-курса через API, автоматически определяется необходимость

проведения повторной экспертизы и, если это необходимо, то автоматически создаётся новая

заявка на размещение курса.

Важно! Из любого статуса заявка может быть закрыта координатором или

правообладателем.

3.1.5.2. Заявка на размещение онлайн-курса (паспорт онлайн-курса)

Представляет собой загрузку описания онлайн-курса с последующей автоматической

валидацией информации на соответствие модели онлайн-курса.

В случае успешной валидации заявке присваивается ID онлайн-курса, и он отправляется

на модерацию. В случае ошибки выдается ошибка и ID не присваивается. Ошибка выдается

синхронно при обращении, асинхронного канала не предусматривается.

20

3.1.7.1. Ответы

Статус

Описание

В теле возвращает статус, возможные варианты: ok, failed, in_progress.

{

200

"status": "in_progress"

}

400

bad request (bad parameters|course already exists)

401

unauthorized

403

permission denied

404

not found

3.1.8. Изменение состояния онлайн-курса

С архивного на активный и наоборот.

Формат

PUT

запроса

https://online.edu.ru/api/v2/registry/courses/update_status?course_id={id}&new_status=active

3.1.8.1. Ответы

Статус

Описание

В теле возвращает статус, возможные варианты: active, archive.

{

200

"status": "active"

}

400

bad request

401

unauthorized

403

permission denied

404

not found

3.1.9. Получение статуса онлайн-курса

Формат запроса

GET https://online.edu.ru/api/v2/registry/courses/status?course_id={id}

3.1.9.1. Ответы

Статус

Описание

В теле возвращает статус, возможные варианты: active, archived,

rightholder_moderation_in_progress, expert_moderation_in_progress,

expert_moderation_failed

200

{

"status": "active"

}

400

bad request

401

unauthorized

403

permission denied

404

not found

24

3.1.10. Список всех платформ

Формат запроса

GET https://online.edu.ru/api/v2/registry/partners/platforms

Возвращает JSON с двумя полями: rows (массив объектов partner) и total_count (число

партнеров). Поля элемента partner в массиве.

Огранич

Обязат

Название

Тип

Описание

Пример

ения

ельное

global_id

string

Да

Идентификатор

50150411-3c15-4b51-a4b3-0511a2fa02bd

Платформы

title

string

Длина от

Да

Название

Открытое образование

1 до 3000

image

string

URL

Да

Ссылка на

https://online.edu.ru/static/courses/i/01.01

изображение

/partner/2.png

url

string

URL

Ссылка на сайт

https://openedu.ru/

Да

Платформы

description

string

Да

Описание

Курсы ведущих вузов России для

каждого без ограничений.

ogrn

string

ОГРН

1234567890

3.1.11. Список всех Правообладателей

Формат запроса

GET https://online.edu.ru/api/v2/registry/partners/rightholders

Возвращает JSON с двумя полями rows - массив объектов institution, total_count - их

количество. Передаваемые параметры объекта institution.

Огранич

Обязат

Название

Тип

Описание

Пример

ения

ельное

global_id

string

Да

Идентификатор

50150411-3c15-4b51-a4b3-

Правообладателя

0511a2fa02bd

title

string

Длина от

Да

Полное

Федеральное государственное

1 до 1000

наименование

автономное образовательное

учреждение высшего образования

"Университет"

short_title

string

Длина от

Сокращенное

Университет

1 до 1000

наименование

ogrn

string

ОГРН

1234567890

3.1.12. Список всех направлений подготовки

Формат запроса

GET https://online.edu.ru/api/v2/registry/courses/directions

Возвращает JSON с двумя полями: rows - массив объектов direction, total_count - их

количество. Передаваемые параметры объекта direction перечислены ниже.

25

Обязат

Название

Тип

Ограничения

Описание

Пример

ельное

global_id

string

Да

Уникальный

167beec6-aee9-46d9-

идентификатор

8c5a-22deccef41cd

онлайн-курса

title

string

Длина от 1 до

Да

Название онлайн-

Ядерная физика

1000

курса

language

string

Двухбуквенный

Да

Язык онлайн-курса

ru

код, может быть

пустым

image

string

Да

Ссылка на

https://online.edu.ru/st

URL, может

изображение

atic/courses/i/01.01/co

быть пустым

urse/11.jpg

description

string

Да

Описание онлайн-

Ядерная физика

курса

является одним из

основных разделов

физики.

started_at

string

Дата в формате:

Нет

Дата ближайшего

2022-09-30

YYYY-MM-DD

запуска

institution_id

string

Да

Идентификатор

50150411-3ae5-4b51-

Правообладателя

a4b3-0511a2fa02bd

partner_id

string

Да

Идентификатор

51150411-3c15-4b51-

Платформы

a4b3-0511a2fa02bd

rating

number

Нет

Общий рейтинг

6.8

0 ≤ … ≤ 10

онлайн-курса

experts_ratin

number

Нет

Экспертный рейтинг

7.5

0 ≤ …≤ 10

g

онлайн-курса

visitors_num

integer

Нет

Количество записей на

234

ber

последнюю

≥ 0

(актуальную) версию

онлайн-курса

business_ver

string

Да

Версия онлайн-курса

sion

institution_sh

string

Да

Краткое название

ort_title

организации

правообладателя

institution_fu

string

Да

Полное название

ll_title

организации

правообладателя

partner_short

string

Да

Краткое название

_title

онлайн-платформы

partner_full_

string

Да

Полное название

title

онлайн-платформы

3.1.15. Получение одного онлайн-курса

Формат

GET https://online.edu.ru/api/v2/registry/courses/global_id

запроса

Пример

https://online.edu.ru/api/courses/v2/course/8c55aeb5-daee-4087-bd76-1135f93877ab

https://online.edu.ru/api/courses/v2/course/430ba5d2-7ee5-43ce-a11f-ed8df4f274fb

https://online.edu.ru/api/courses/v2/course/bdf8ef7f-e2fa-4e5c-84f3-2a8bb738ef40

27

4. Цифровое портфолио

4.1. Участие пользователя в курсе

4.1.1. Регистрация пользователя на курс

4.1.1.1. Объект регистрации пользователя на курс

Название

Тип

Обязательное

Описание

Пример

course_id

string

Да

Глобальный идентификатор

167beec6-aee9-46d9-8c5a-

курса в реестре

22deccef41cd

session_id

string

Да

Код сессии на платформе

489/ITMOUniversity/INTP

RO/fall_2022

user_id

string

Да

Идентификатор

ffb79db3-f762-498c-92b0-

пользователя в СЦОС

42fb7f4a8095

enroll_date

string

Да

Дата регистрации на курс в

2022-03-

формате:

13T22:55:03+0300

YYYY-MM-DDThh:mm:ssZ

session_start

string

Нет

Дата начала сессии курса в

2022-01-01

формате:

YYYY-MM-DD

session_end

string

Нет

Дата окончания сессии курса

нн

в формате:

YYYY-MM-DD

4.1.1.2. Регистрация списка слушателей на курс

Формат запроса

POST https://online.edu.ru/api/v2/courses/participation

Входные данные

Массив объектов регистрации на курс.

Возвращаемое значение

HTTP response status 200 (OK) - в любом случае вместе с массивом

результатов регистрации пользователя на курс

4.1.1.3. Объект результата регистрации/отмены регистрации пользователя на курс

Название

Тип

Обязательное

Описание

Пример

user_id

string

Да

Идентификатор

ffb79db3-f762-498c-92b0-

пользователя в СЦОС

42fb7f4a8095

course_id

string

Да

Глобальный

167beec6-aee9-46d9-8c5a-

идентификатор курса в

22deccef41cd

реестре

session_id

string

Да

Код сессии на платформе

489/ITMOUniversity/INTPRO/fa

ll_2022

saved

boolean

Да

Флаг записи результата

true

4.1.1.4. Объект отмены/проверки регистрации на курсе

Название

Тип

Обязательное

Описание

Пример

course_id

string

Да

Глобальный

167beec6-aee9-46d9-8c5a-

идентификатор курса в

22deccef41cd

реестре

session_id

string

Да

Код сессии на платформе

489/ITMOUniversity/INTPRO/f

all_2022

33

Название

Тип

Обязательное

Описание

Пример

user_id

string

Да

Идентификатор

ffb79db3-f762-498c-92b0-

пользователя в СЦОС

42fb7f4a8095

4.1.1.5. Отмена регистрации слушателя на курсе

Формат запроса

DELETE https://online.edu.ru/api/v2/courses/participation

Входные данные

Массив объектов отмены/проверки регистрации на курсе.

Возвращаемое значение

HTTP response status 200 (OK) - в любом случае вместе с массивом

результатов отмены регистрации пользователя на курс

4.1.1.6. Проверка регистрации слушателя на курсе по СЦОС ИД

Формат запроса

GET

https://online.edu.ru/api/v2/courses/participation?{course_id}&{user_id}&{s

ession_id}

Входные данные

course_id - идентификатор курса в реестре

session_id - идентификатор сессии курса

user_id - Идентификатор пользователя в СЦОС

Возвращаемое значение

HTTP response status 404 (NOT FOUND) - в случае, если пользователь

или курс не были найдены

HTTP response status 200 (OK)

Пример тела ответа:

{

"statusType": "RESULT_LIST",

"message": "User with specified usia id not found",

"data": "USER_NOT_FOUND"

}

Где

message - описание результата

data - может принимать одно из следующих значений:

● USER_NOT_FOUND - пользователь с указанным user_id не

найден

● COURSE_NOT_FOUND - курс с указанным course_id не найден

● ACTIVE_SESSION_EXISTS - найден активный объект участия в

онлайн-курсе с session_id и course_id

● SESSION_NOT_ACTIVE - найден неактивный объект участия в

онлайн-курсе с session_id и course_id

● PARTICIPATION_NOT_FOUND - объект участия в онлайн-

курсе с session_id и course_id не найден

4.1.1.7. Проверка регистрации слушателя на курсе по СЦОС ИД

Формат запроса

GET

https://online.edu.ru/api/v2/courses/participation?{course_id}&{esia_id}&{s

ession_id}

Входные данные

course_id - идентификатор курса в реестре

session_id - идентификатор сессии курса

esia_id - идентификатор пользователя в ЕСИА

Возвращаемое значение

HTTP response status 404 (NOT FOUND) - в случае, если пользователь

или курс не были найдены

HTTP response status 200 (OK)

Пример тела ответа:

{

34

"statusType": "RESULT_LIST",

"message": "User with specified esia id not found",

"data": "USER_NOT_FOUND"

}

Где

message - описание результата

data - может принимать одно из следующих значений:

● USER_NOT_FOUND - пользователь с указанным esia_id не

найден

● COURSE_NOT_FOUND - курс с указанным course_id не найден

● ACTIVE_SESSION_EXISTS - найден активный объект участия в

онлайн-курсе с session_id и course_id

● SESSION_NOT_ACTIVE - найден неактивный объект участия в

онлайн-курсе с session_id и course_id

● PARTICIPATION_NOT_FOUND - объект участия в онлайн-

курсе с session_id и course_id не найден

4.1.2. Результаты пользователя на онлайн курсе

4.1.2.1. Объект промежуточного результата

Обязате

Название

Тип

Ограничение

Описание

Пример

льное

course_id

string

Да

Глобальный

167beec6-aee9-

идентификатор курса в

46d9-8c5a-

реестре

22deccef41cd

session_id

string

Да

Код сессии на платформе

489/ITMOUniversi

ty/INTPRO/fall_20

22

user_id

string

Да

Идентификатор

ffb79db3-f762-

пользователя в СЦОС

498c-92b0-

42fb7f4a8095

date

string

YYYY-MM-

Да

Дата прохождения

2022-01-

DDThh:mm:ssZ

испытания

01T21:02:00+0300

rating

number

[0.00, 100.00]

Да

Оценка (в процентах), если

67

она известна сразу или null,

если для задания

установлена отложенная

проверка или запрещен

показ результатов

progress

number

[0.00, 100.00]

Нет

Общий прогресс в курсе

35

или null

proctored

string

Нет

Имя используемой в курсе

ITMOproctor

системы прокторинга.

null - если таковая система

не использовалась

checkpoint

string

Да

Полное название

Лабораторная

_name

испытания

работа №2

checkpoint

string

Да

Идентификатор испытания

53ef8b1c25d348e0

_id

в ИС платформы

97a8111f05537264

35

4.1.2.2. Объект ответа на запрос на публикацию массива результатов

Обязате

Название

Тип

Ограничение

Описание

Пример

льное

user_id

string

Да

Идентификатор

ffb79db3-f762-

пользователя в СЦОС

498c-92b0-

42fb7f4a8095

date

string

YYYY-MM-

Да

Дата прохождения

2022-03-

DDThh:mm:ssZ

испытания

13T22:55:03+0300

checkpoint_id

string

Да

Идентификатор

53ef8b1c25d348e0

испытания в ИС

97a8111f0553726

платформы

4

saved

boolean

Да

Флаг записи результата

true

4.1.2.3. Публикация результатов обучения массивом объектов

Формат запроса

https://online.edu.ru/api/v2/courses/results

Входные данные

Массив значений, указанных в объекте промежуточного результата,

Возвращаемое

HTTP response status 200 (OK) - в любом случае вместе с именованным

значение

массивом объектов ответа на запрос на публикацию массива результатов.

Если объект добавить не удалось, то формируется статус saved = false.

4.1.2.4. Объект публикации прогресса обучения

Название

Тип

Обязательное

Описание

Пример

course_id

string

Да

Глобальный идентификатор

167beec6-aee9-46d9-8c5a-

курса в реестре

22deccef41cd

session_id

string

Да

Код сессии на платформе

489/ITMOUniversity/INTP

RO/fall_2022

user_id

string

Да

Идентификатор

ffb79db3-f762-498c-92b0-

пользователя в СЦОС

42fb7f4a8095

progress

number

Да

Общий прогресс в курсе

35.0

4.1.2.5. Объект ответа на запрос на публикацию массива прогрессов обучения

Огранич

Обязат

Название

Тип

Описание

Пример

ение

ельное

user_id

string

Да

Идентификатор

ffb79db3-f762-498c-

пользователя в СЦОС

92b0-42fb7f4a8095

course_id

string

Да

Глобальный идентификатор

167beec6-aee9-46d9-

курса в реестре

8c5a-22deccef41cd

session_id

string

Да

Код сессии на платформе

489/ITMOUniversity/I

NTPRO/fall_2022

progress

number

Да

Общий прогресс в курсе

35.0

saved

boolean

Да

Флаг записи результата

true

4.1.2.6. Публикация прогрессов обучения именованным массивом объектов

Формат запроса

https://online.edu.ru/api/v2/courses/results/progress

Входные данные

Массив значений, указанных в объекте публикации прогресса обучения

Возвращаемое

HTTP response status 200 (OK) - в любом случае вместе с именованным

значение

массивом объектов ответа на запрос на публикацию массива прогрессов

обучения. Если объект добавить не удалось, то формируется статус saved =

false.

36

4.1.2.7. Получение информации о текущем прогрессе слушателя курса

Формат запроса

GET https://online.edu.ru/api/v2/courses/results/progress?(user_id={user_id} или

esia_id={esia_id}) & course_id={course_id} [&session_id={session_id}]

Входные данные

user_id - идентификатор слушателя в СЦОС.

esia_id - идентификатор слушателя в ЕСИА.

course_id - идентификатор онлайн курса в реестре онлайн курсов.

Опциональный параметр:

session_id - идентификатор сессии онлайн курса.

Возвращаемое

В случае, если параметр session_id не указан, будет возвращен HTTP response

значение

status 200 (Ok) и прогресс слушателя с user_id в последней сессии

прохождения онлайн курса с course_id.

Если параметр session_id указан, будет возвращен HTTP response status 200

(Ok) и прогресс слушателя с user_id в сессии с указанным session_id онлайн

курса с course_id.

Прогресс возвращается в виде объекта

{

"progress": value

}

где value - число с плавающей точкой в диапазоне 0.0-100.0

4.1.2.8. Получение информации о текущем прогрессе списка слушателей курса

Формат запроса

POST https://online.edu.ru/api/v2/courses/results/progress/list

Входные данные

Объект запроса на получение информации о текущем прогрессе списка

слушателей курса

Возвращаемое

В случае, если параметр session_id не указан, будет возвращен HTTP response

значение

status 200 (Ok) и прогресс слушателя в последней сессии прохождения онлайн

курса с course_id.

Если параметр session_id указан, будет возвращен HTTP response status 200

(Ok) и прогресс слушателей в сессии с указанным session_id онлайн курса с

course_id.

Ответ возвращается в виде списка объектов ответа на запрос о получении

информации о текущем прогрессе списка слушателей курса

4.1.2.9. Объект запроса на получение информации о текущем прогрессе списка

слушателей курса

Обязат

Название

Тип

Описание

Пример

ельное

user_ids

array

Да

Массив идентификатором

"user ids": ["ffb79db3-f762-498c-

обучающихся. Может

92b0-42fb7f4a8095", "b0314295-

содержать как СЦОС ID, так и

a0cb-4c90-a0c2-0ff69a4133ba"]

ЕСИА ID

course_id

string

Да

Глобальный идентификатор

167beec6-aee9-46d9-8c5a-

курса в реестре

22deccef41cd

session_id

string

Нет

Код сессии на платформе

489/ITMOUniversity/INTPRO/fa

ll_2022

4.1.2.10. Объект ответа на запрос о получении информации о текущем прогрессе списка

слушателей курса

Название

Тип

Обязательное

Описание

user_id

string

Да

Идентификатор пользователя в СЦОС

esia_id

string

Идентификатор пользователя в ЕСИА

37

Название

Тип

Обязательное

Описание

course_id

string

Да

Глобальный идентификатор курса в реестре

session_id

string

Код сессии на платформе

progress

float

Прогресс пользователя на курсе

4.1.2.11. Получение информации о результатах испытаний слушателя курса

Формат запроса

GET https://online.edu.ru/api/v2/courses/results?(user_id={user_id} ИЛИ

esia_id={esia_id}) &courseId={courseId}[&sessionId={sessionId}]

Входные данные

user_id - идентификатор слушателя в СЦОС.

esia_id - идентификатор слушателя в ЕСИА.

course_id - идентификатор онлайн курса в реестре онлайн курсов.

Опциональный параметр:

session_id - идентификатор сессии онлайн курса.

Возвращаемое

HTTP response status 200 (Ok) и массив объектов промежуточного результата для

значение

сессии с session_id (если указано, иначе для последней сессии в курсе) слушателя с

user_id в курсе с course_id

HTTP response status 200 (Ok) и пустой список результатов в случае отсутствия

подходящих под запрос результатов промежуточных испытаний.

4.1.2.12. Объект запроса на получение информации о результатах испытаний для массива

слушателей курса

Название

Тип

Обязательное

Описание

Пример

user_ids

array

Да

Массив ЕСИА ID

"user_ids": ["ffb79db3-f762-

обучающихся

498c-92b0-42fb7f4a8095",

"b0314295-a0cb-4c90-a0c2-

0ff69a4133ba"]

course_id

string

Да

Глобальный

167beec6-aee9-46d9-8c5a-

идентификатор курса в

22deccef41cd

реестре

session_id

string

Нет

Код сессии на

489/ITMOUniversity/INTPRO/

платформе

fall_2022

4.1.2.13. Получение информации о результатах испытаний для массива слушателей курса

Формат запроса

POST https://online.edu.ru/api/v2/courses/results/list

Входные данные

Объект запроса получение информации о результатах испытаний для массива

слушателей курса

Возвращаемое

HTTP response status 200 (Ok) и массив объектов промежуточного результата

значение

для сессии с session_id (если указано, иначе для последней сессии в курсе) в

курсе с course_id для слушателей, user_id которых указаны в объекте запроса.

HTTP response status 200 (Ok) и пустой список результатов в случае

отсутствия подходящих под запрос результатов промежуточных испытаний.

38

4.1.2.14. Объект ответа на запрос о получении информации об индивидуальной траектории

учащегося

Обязате

Название

Тип

Описание

Пример

льное

active_courses

string[]

Нет

Список идентификаторов

["5663f214846441368efaaa1b0

курсов в реестре онлайн

6d5ee9d",

курсов, которые слушатель

"9868912c06624b5dafcb9ecb8c

проходит на момент

0e03ae"]

выполнения запроса.

finished_courses

string[]

Нет

Список идентификаторов

["0ca3e2c8ad684761a8259ccad

курсов в реестре онлайн

383758e",

курсов, которые слушатель

"0ca3e2c8ad684761a8259ccad3

окончил к моменту

83758e"]

выполнения запроса.

interests

string[]

Нет

Список интересов учащегося

["средневековая литература",

"образование", "математика",

"ядерная физика",

"кристаллография"]

4.1.2.15. Получение информации об индивидуальной траектории учащегося

Формат запроса

GET https://online.edu.ru/api/v2/trajectories?(user_id={user_id} ИЛИ

esia_id={esia_id})

Входные данные

user_id - идентификатор слушателя в СЦОС.

ИЛИ

esia_id - идентификатор слушателя в ЕСИА.

Возвращаемое

HTTP response status 200 (Ok)

значение

Объект ответа на запрос о получении информации об индивидуальной

траектории слушателя в случае успешного запрос

HTTP response status 424 (Failed Dependency) - слушатель с указанным ID не

найден.

4.1.2.16. Получение информации о текущей оценке списка слушателей курса

Формат запроса

POST https://online.edu.ru/api/v2/courses/participation/mark/list

Входные данные

Объект запроса на получение информации о текущей оценке списка

слушателей курса

Возвращаемое

В случае, если параметр session_id не указан, будет возвращен HTTP response

значение

status 200 (Ok).

Ответ возвращается в виде списка объектов ответа на запрос о получении

информации о текущей оценке списка слушателей курса

4.1.2.17. Объект запроса на получение информации о текущей оценке списка слушателей

курса

Название

Тип

Обязательное

Описание

Пример

user_ids

array

Да

Массив идентификатором

"user_ids": ["e85df2a8-693f-4629-

обучающихся. Может

9044-e16c083414f5", "b0314295-

содержать как СЦОС ID,

a0cb-4c90-a0c2-0ff69a4133ba"]

так и ЕСИА ID

course_id

string

Да

Глобальный

d0b39b0ee0c74a81be94093178f0c

идентификатор курса в

1c7

реестре

39

Название

Тип

Обязательное

Описание

Пример

session_id

string

Да

Код сессии на платформе

course-

v1:ITMOUniversity+LINACS+spri

ng_2022

4.1.2.18. Объект ответа на запрос о получении информации о текущей оценке списка

слушателей курса

Название

Тип

Обязательное

Описание

user_id

string

Да

Идентификатор пользователя в СЦОС

course_id

string

Да

Глобальный идентификатор курса в реестре

session_id

string

Да

Код сессии на платформе

mark

string

Да

Оценка пользователя на курсе

4.1.2.19. Создание информации о текущей оценке списка слушателей курса

Формат запроса

POST https://online.edu.ru/api/v2/courses/participation/mark

Входные данные

Массив объектов запроса на добавление текущей оценки списка слушателей

курса

Возвращаемое

Если параметр session_id указан, будет возвращен HTTP response status 200

значение

(Ok) и статус сохранения оценки saved в сессии с указанным session_id

онлайн курса с course_id.

Ответ возвращается в виде списка объектов ответа на запрос о получении

информации о текущей оценке списка слушателей курса

4.1.2.20. Объект запроса на добавление текущей оценки списка слушателей курса

Название

Тип

Обязательное

Описание

Пример

user_id

string

Да

Идентификатор

"user_id":"e85df2a8-693f-

обучающегося.

4629-9044-e16c083414f5"

Может содержать как

СЦОС ID, так и ЕСИА ID

course_id

string

Да

Глобальный идентификатор

d0b39b0ee0c74a81be94093178

курса в реестре

f0c1c7

session_id

string

Да

Код сессии на платформе

course-

v1:ITMOUniversity+LINACS+

spring_2022

mark

string

Да

оценка студента

5

4.1.2.21. Объект ответа на запрос о добавлении текущей оценки списка слушателей курса

Название

Тип

Обязательное

Описание

user_id

string

Да

Идентификатор пользователя в СЦОС

course_id

string

Да

Глобальный идентификатор курса в реестре

session_id

string

Да

Код сессии на платформе

saved

boolean

Да

Статус добавления оценки

40

4.1.3. Сертификаты пользователя в онлайн-курсе

4.1.3.1. Объект запроса на публикацию сертификата в Цифровое портфолио

Ограниче

Обязател

Название

Тип

Описание

Пример

ния

ьное

certificate_nu

string

Да

Номер сертификата в

3594 121539

mber

образовательной организации

date

string

Дата в

Да

Дата выдачи сертификата

2022-10-10

формате:

YYYY-

MM-DD

student_name

string

Да

Имя обучающегося

Vladimir

student_surna

string

Да

Фамилия обучающегося

Vosko

me

student_patron

string

Нет

Отчество обучающегося

Nikolaevich

ymic_name

user_id

string

Да

Идентификатор обучающегося

ffb79db3-f762-498c-

в СЦОС

92b0-42fb7f4a8095

course_id

string

Да

Идентификатор курса в реестре

167beec6-aee9-46d9-

онлайн-курсов

8c5a-22deccef41cd

session_id

string

Нет

Идентификатор сессии для

489/ITMOUniversity/IN

выбранного курса в реестре. В

TPRO/fall_2022

случае его наличия публикация

сертификата возможна после

закрытия сессии курса

платформой Online-обучения.

enrollment_ac

string

Да

Реквизиты распорядительного

Приказ №5-У

t

акта о зачислении на онлайн-

курс

enrollment_da

string

Да

Дата распорядительного акта о

2022-10-10

te

зачислении на онлайн-курс

completion_ac

string

Да

Реквизиты распорядительного

Приказ №5-0

t

акта о прекращении изучения

онлайн-курса

completion_da

string

Да

Дата распорядительного акта о

2022-10-10

te

прекращении изучения онлайн-

курса

document

Multipart

До 5 МБ

Да

Файл документа сертификата

File

4.1.3.2. Объект ответа на запрос о чтении сертификатов - CertificateResponse

Ограничен

Обязател

Название

Тип

Описание

Пример

ия

ьное

cert_id

long

Да

Идентификатор сертификата в

634

реестре сертификатов

certificate_numbe

string

Да

Номер сертификата в

3594 121539

r

образовательной организации

date

string

Дата в

Да

Дата выдачи сертификата

2022-10-10

формате:

YYYY-

MM-DD

course_name

string

Нет

Название онлайн-курса

Java programming

университета

language

student_name

string

Да

Имя обучающегося

Vladimir

student_surname

string

Да

Фамилия обучающегося

Vosko

student_patronym

string

Нет

Отчество обучающегося

Nikolaevich

ic_name

41

Ограничен

Обязател

Название

Тип

Описание

Пример

ия

ьное

user_id

string

Да

Идентификатор обучающегося

ffb79db3-f762-

в СЦОС

498c-92b0-

42fb7f4a8095

course_id

string

Да

Идентификатор курса в реестре

167beec6-aee9-

онлайн-курсов

46d9-8c5a-

22deccef41cd

session_id

string

Нет

Идентификатор сессии для

489/ITMOUniversi

выбранного курса в реестре

ty/INTPRO/fall_20

22

enrollment_act

string

Да

Реквизиты распорядительного

Приказ №5-У

акта о зачислении на онлайн-

курс

enrollment_date

string

Да

Дата распорядительного акта о

2022-10-10

зачислении на онлайн-курс

completion_act

string

Да

Реквизиты распорядительного

Приказ №5-0

акта о прекращении изучения

онлайн-курса

completion_date

string

Да

Дата распорядительного акта о

2022-10-10

прекращении изучения онлайн-

курса

status

integer

Значение из

Да

Статус публикации сертификата

7

справочник

в блокчейн Портфолио и ГИС

а 1.3.3

«Контингент»

4.1.3.3. Статусы сертификата в запросах к Цифровому портфолио

Название

Тип

Обязат

Описание

Пример

ельное

stored

Bit:0

n/a

Сертификат записан в Цифровое портфолио

1

blockchained

Bit:1

n/a

Сертификат помещен в блокчейн сертификатов

1

exported2GIS

Bit:2

n/a

Сертификат успешно записан в ГИС «Контингент»

0

revoked

Bit:3

n/a

Сертификат отозван выдавшей организацией

0

errors

Bit:8-15

0 - нет ошибки

0

1 - сертификат с таким ID отсутствует в системе

warnings

Bit:16-23

4.1.3.4. Получение данных сертификата с заданным идентификатором сертификата

Формат запроса

GET https://online.edu.ru/api/v2/certificates/{certificate_id}

Входные данные

certificate_id - идентификатор сертификата в цифровом портфолио.

Возвращаемое значение

HTTP status code 200 (ОК) и пустой список значений - в случае

отсутствия сертификата с certificate_id в системе или недоступности его

для образовательной организации

HTTP status code 200 (ОК) и список с единственным объектом

CertificateResponse, в случае успешного запроса

42

4.1.3.9. Получение сертификатов для слушателя с указанным идентификатором

слушателя и идентификатором университета

Формат запроса

GET

https://online.edu.ru/api/v2/certificates?university_ogrn={university_ogrn}&(user

_id={user_id} ИЛИ esia_id={esia_id})

Входные данные

university_ogrn - ОГРН (тип поля - строка) образовательной организации,

заданный при регистрации на ресурсе портфолио. Указывается организация,

выдавшая сертификат.

user_id - идентификатор слушателя в СЦОС.

ИЛИ

esia_id - идентификатор слушателя в ЕСИА.

Возвращаемое

HTTP status code 200 (ОК) и массив объектов CertificateResponse

значение

сертификатов, выданных университетом university_ogrn студенту

с идентификатором user_id.

HTTP status code 200 (ОК) и пустой список значений - в случае отсутствия

сертификатов, подходящих под запрос, или недоступности их

для образовательной организации.

4.1.3.10. Получение сертификатов для слушателя с указанным идентификатором

слушателя на выбранный интервал дат

Формат запроса

GET

https://online.edu.ru/api/v2/certificates?start_date={start_date}&finish_date={finis

h_date}&(user_id={user_id} ИЛИ esia_id={esia_id})

Входные данные

start_date - дата начала запрашиваемого периода в формате YYYY-MM-DD.

finish_date - дата окончания запрашиваемого периода в формате YYYY-MM-

DD.

user_id - идентификатор слушателя в СЦОС.

ИЛИ

esia_id - идентификатор слушателя в ЕСИА.

Возвращаемое

HTTP status code 200 (ОК) и массив объектов CertificateResponse

значение

сертификатов, выданных слушателю с идентификатором user_id в период с

start_date по finish_date.

HTTP status code 200 (ОК) и пустой список значений - в случае отсутствия

сертификатов, подходящих под запрос, или недоступности их

для образовательной организации.

44

4.1.4.2. Получение записи об участии пользователя в олимпиаде (включая контрольные

точки) по идентификатору записи

Формат запроса

GET /api/v2/competitions/participation/{participation_id}

Входные данные

participation_id - идентификатор записи об участии в олимпиаде

Возвращаемое

HTTP response status 200 (Ok) и объект записи о прохождении олимпиады

значение

HTTP response status 404 (Not Found) в случае отсутствия записи с таким ID

4.1.4.3. Получение информации об олимпиаде по идентификатору записи

Формат запроса

GET /api/v1/competitions/{competitionId}

Входные данные

competitionId - идентификатор олимпиады

Возвращаемое

HTTP response status 200 (Ok) и объект записи об олимпиаде

значение

HTTP response status 404 (Not Found) в случае отсутствия записи с таким

идентификатором

4.1.4.4. Получение списка сертификатов по олимпиадам пользователя по

идентификатору

Формат запроса

GET /api/v2/competitions/certificates?[{user_id=user_id}/{esia_id=esia_id}]

Входные данные

user_id - Идентификатор пользователя в СЦОС

ИЛИ

esia_id - Идентификатор пользователя в ЕСИА

Возвращаемое

HTTP response status 200 (Ok) и массив записей о полученных сертификатах

значение

по олимпиадам

HTTP response status 404 (Not Found) в случае отсутствия записей для

пользователя с таким ID

4.1.4.5. Объект записи об олимпиаде

Название

Тип

Ограничение

Обязательное

Описание

id

long

Да

Идентификатор олимпиады

name

string

Да

Название олимпиады

sponsor

string

Да

Организатор олимпиады

location

string

Да

Место проведения

url

string

Да

Адрес сайта олимпиады

image_url

string

Нет

Логотип олимпиады

description

string

Нет

Описание

background_url

string

Нет

Большое изображение (подложка)

started_at

date

yyyy-MM-dd

Нет

Дата начала

finished_at

date

yyyy-MM-dd

Нет

Дата окончания

4.1.4.6. Объект записи об участии в олимпиаде

Обязател

Название

Тип

Описание

ьное

id

long

Да

Идентификатор записи об участии

competition_id

long

Да

Идентификатор олимпиады

user_id

string

Да

Идентификатор пользователя в СЦОС

total_progress

float

Нет

Прогресс по олимпиаде

checkpoints

checkpoint[]

Нет

Массив контрольных точек

46