api
mrs > check_applications > create
Описание
Проверка статуса записи пользователя по определенному модулю
Пример запроса
POST /api/mrs/check_applications/{"course_id": 1, "enrollments": [{"unti_id": 1, "module_num": 1}]}
Пример ответа
* 200 [{"unti_id": 1, "module_num": 1, "statuses": ["finished"]}] || [{"unti_id": 1, "module_num": 1, "error": "..."}]
* 400 некорректные параметры или курс не найден
* 403 не передан api key или он неверен
v1 > 1c > transfert-availability-status > create
Описание
Простановка статуса доступности трансфертов на определенный год
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора
Пример post запроса
POST /api/v1/1c/transfert-availability-status/{
"project": 41,
"year": 2021,
"available": true
}
Параметры post запроса
* project - id проекта, int, обязательный параметр
* year - год, int, обязательный параметр
* available - доступны ли трансферты, bool, обязательный параметр
Пример ответа
* 200 успешно
* 400 если не указаны обязательные параметры или они некорректны
* 401 если запрос не авторизован
* 403 если пользователь не является администратором
v1 > 1c > transfert-status > create
Описание
Изменение статуса трансферта
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора
Пример post запроса
POST /api/v1/1c/transfert-status/{
"application_id": 1
"status": "activated"
}
Параметры post запроса
* application_id - id заявки, обязательный параметр
* status - "activated" (активирован), "conditionally_activated" (активирован условно),
"awaiting_closure" (к погашению), "adjustment" (корректировка), "closed" (погашен), "booked" (забронирован),
"revoked" (аннулирован), "no_transferts" (нет трансфертов). обязательный параметр
Необязательные параметры post запроса
* proposal_id - идентификатор из 1с, может передаваться в случае status=booked
Пример ответа
* 200 {"success": true}
* 400 если не хватает обязательных параметров, переданы некорректные параметры или статус нельзя изменить
* 401 если запрос не авторизован
* 403 если пользователь не является администратором
* 404 если не найден пользователь/курс/заявка
v1 > COF-exit-exam > list
Описание
Итоговое испытание - получить информацию
50 и 111 проект
Запрос должен содержать хедер x-vi-plp-api-key
Пример запроса
GET /api/v1/COF-exit-exam
Параметры get-запроса
* unti_id – идентификатор пользователя, обязательный параметр
Пример ответа
{
"unti_id": 111,
"epgu_id": 2222,
"is_valid": 1,
"valid_for_retry": false,
"course_id": 123,
"org_id": 123,
"application_id": 123,
"untill_dt": "30.10.2024",
}
В случае когда нет активной Анкеты в SSO на данный UntiID:
{
"unti_id": 111,
"is_valid": 0,
}
В случае когда больше 1 активной Анкеты в SSO на данный UntiID:
{
"unti_id": 111,
"is_valid": -1,
}
v1 > COF-exit-exam > create
Описание
Отправка статуса итогового испытания
50 и 111 проект
Запрос должен содержать хедер x-vi-plp-api-key
Пример запроса
POST /api/v1/COF-exit-exam/{
"unti_id": "123",
"application_id": 222
"status": 1,
}
Тело запроса
{
"unti_id": 111,
"application_id": 2222,
"status": start,
"motivation_grade": 1,
"algorithm_grade": 2,
"language_grade": 3,
"is_timeout": True,
"exit_end_dt": "YYYY-MM-DDThh:mm:ss±hh"
}
Параметры post-запроса
* unti_id – идентификатор пользователя
* application_id - идентификатор заявки, обязательный параметр
* status - статус прохождения испытания, обязательный параметр
Для статусов Success или UnSuccess дополнительные параметры передавать обязательно
* motivation_grade
* algorithm_grade
* language_grade
* is_timeout
* exit_end_dt
Пример ответа
* {"code": 200,"success": "true"}
v1 > check > list
Описание
Проверка статуса приложения, связи с системами, с которыми оно общается, и с базой данных
Пример запроса
GET /api/check/mysql/?x-api-key=key
GET /api/check/release/?x-api-key=key
Пример ответа
* если запрашивался статус по всем системам, вернет словарь и код 200
{
"mysql": "ok",
"release": "1.1.0",
}
* если запрашивался статус по конкретной системе, вернется только код (200, если все ок),
а если запрашивался релиз, в ответе также будет код релиза
* 403 api key отсутствует или неправильный
v1 > check > read
Описание
Проверка статуса приложения, связи с системами, с которыми оно общается, и с базой данных
Пример запроса
GET /api/check/mysql/?x-api-key=key
GET /api/check/release/?x-api-key=key
Пример ответа
* если запрашивался статус по всем системам, вернет словарь и код 200
{
"mysql": "ok",
"release": "1.1.0",
}
* если запрашивался статус по конкретной системе, вернется только код (200, если все ок),
а если запрашивался релиз, в ответе также будет код релиза
* 403 api key отсутствует или неправильный
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
sys_type required |
v1 > course > list
Описание
Постраничное получение информации обо всех курсах
Запрос должен содержать хедер x-plp-api-key
Пример get запроса
GET /api/v1/course/
Пример ответа
* {
"count": 0,
"next": null,
"previous": null,
"results": []
}
* 403 если не хватает прав
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
v1 > course > read
Описание
Получение информации о курсе
Запрос должен содержать хедер x-plp-api-key
Пример get запроса
GET /api/v1/course/1/
Пример ответа
* {
"id": 1,
"slug": "course",
"title": "course",
"cover": "http://example.com/cover/image.jpg",
"description": "<p>course description</p>",
"about": "<p>course annotation</p>,
"external_url": "http://example.com",
"points": 1,
"specifications": "",
"results": "",
"duration": 1,
"additional_info": "",
"status": "published",
"syllabus": "",
"archived": false,
"competences": [{"guid": "00000000-0000-0000-0000-000000000000", "title": "competence"}],
"tools": [{"guid": "00000000-0000-0000-0000-000000000000", "title": "tool"}],
"instructors": [{"last_name": "last_name", "first_name": "first_name", "second_name": "second_name"}],
"university_slug": "university",
"course_format": "online",
"rall_uuid": "00000000-0000-0000-0000-000000000000",
"is_epgu": false
}
* 403 если не хватает прав
* 404 если курс не найден
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > course > enroll > list
Описание
Проверка записан ли пользователь на курс
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример get запроса
GET /api/v1/course/enroll/?platform_id=platform&unti_id=1&external_course_id=course
Параметры get запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр
Пример ответа
* {"enrolled": true}
* 400 если не хватает параметров в запросе
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
v1 > course > enroll > create
Описание
Запись пользователя не курс
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример post запроса
POST /api/v1/course/enroll/{
"platform_id": "platform",
"unti_id": 1
"external_course_id": "course"
}
Параметры post запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр
Пример ответа
* 201 если запись на курс создана
* 400 если не хватает параметров в запросе
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
* 424 ошибка при создании записи
v1 > course > enroll > delete
Описание
Удаление записи пользователя на курс
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример delete запроса
DELETE /api/v1/course/enroll/{
"platform_id": "platform",
"unti_id": 1
"external_course_id": "course",
"reason": "no_exam"
}
Параметры delete запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр
* reason - причина отчисления, возможные значения: "no_exam" (Не дошёл до итоговой аттестации) или
"exam_failed" (Неудовлетворительно сдал итоговую аттестацию). необязательный параметр
Пример ответа
* 204 если запись удалена
* 400 если не хватает параметров в запросе
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
* 424 ошибка при удалении записи
v1 > course > enroll > check > list
Описание
Проверка возможности записи пользователя на курс.
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример get запроса
GET /api/v1/course/enroll/check/?platform_id=platform&unti_id=1&external_course_id=course
Параметры get запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр
Пример ответа
* {"can_enroll": true}
* 400 если не хватает параметров в запросе
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
v1 > course > enroll > steps-enroll > create
Описание
"Запись" пользователя по запросу steps. Действует также, как если бы пользователь
нажал кнопку записи в каталоге
Запрос должен содержать хедер x-plp-api-key
Пример запроса
POST /api/v1/course/enroll/steps-enroll/
Параметры post запроса
* author_unti_id - uuid автора коллекции, обязательный параметр
* rall_uuid - uuid курса в rall, должен присутствовать либо этот параметр, либо course_id
* course_id - id курса, число
* project_id - id проекта, число, обязательный параметр, если курс участвует в проекте
* unti_id - unti_id пользователя, обязательный параметр
Пример ответа
* 200 {"redirect_url": "..."} если запись создана или пользователь уже записан
* 400 {"error": "description"}, если не переданы обязательные параметры или они некорректны,
или пользователь не может быть записан
* 403 если не передан api key
v1 > course > set-finished > create
Описание
Проставление пользователю статуса окончившего курс
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример post запроса
POST /api/v1/course/set-finished/{
"platform_id": "platform",
"unti_id": 1
"external_course_id": "course"
}
Параметры post запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр
Пример ответа
* 200 если у пользователя уже есть этот статус
* 201 если запись успешно обновлена
* 400 если не хватает параметров в запросе
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
* 412 пользователь не записан на курс
* 417 не удалось проставить статус
v1 > course > taxonomy > list
Описание
Просмотр разметки курса по таксономии
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя,
имеющего доступ для редактирования курса
Пример запроса
GET /api/v1/course/taxonomy/?course_id=1
Параметры GET запроса
* course_id - id курса в каталоге (int) или uuid в rall, обязательный параметр
Пример ответа
* 200 {"tags": ["11111111-1111-1111-11111111"]}
* 400 не передан course_id
* 401 запрос не авторизован
* 403 у пользователя нет доступа к курсу
* 404 курс не найден
v1 > course > taxonomy > create
Описание
Добавление тегов к существующей разметке
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя,
имеющего доступ для редактирования курса
Пример запроса
POST /api/v1/course/taxonomy/
Параметры POST запроса
* course_id - id курса в каталоге (int) или uuid в rall, обязательный параметр
* tags - массив строк с uuid таксономии, обязательный параметр
Пример ответа
* 200 {"tags": ["11111111-1111-1111-11111111"]} - новая разметка курса
* 400 не передан обязательный параметр или такой набор тегов нельзя добавить из-за нарушения иерархии
* 401 запрос не авторизован
* 403 у пользователя нет доступа к курсу
* 404 курс/тег не найден
v1 > course > taxonomy > update
Описание
Установка новой разметки для курса
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя,
имеющего доступ для редактирования курса
Пример запроса
PUT /api/v1/course/taxonomy/
Параметры POST запроса
* course_id - id курса в каталоге (int) или uuid в rall, обязательный параметр
* tags - массив строк с uuid таксономии, обязательный параметр
Пример ответа
* 200 {"tags": ["11111111-1111-1111-11111111"]} - новая разметка курса
* 400 не передан обязательный параметр или такой набор тегов нельзя добавить из-за нарушения иерархии
* 401 запрос не авторизован
* 403 у пользователя нет доступа к курсу
* 404 курс/тег не найден
v1 > course > taxonomy > delete
Описание
Удаление тегов из существующей разметки. При указании тега верхнего уровня все теги теги наследнкики будут
удалены автоматически
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя,
имеющего доступ для редактирования курса
Пример запроса
DELETE /api/v1/course/taxonomy/
Параметры POST запроса
* course_id - id курса в каталоге (int) или uuid в rall, обязательный параметр
* tags - массив строк с uuid таксономии, обязательный параметр
Пример ответа
* 200 {"tags": ["11111111-1111-1111-11111111"]} - новая разметка курса
* 400 не передан обязательный параметр или такой набор тегов нельзя добавить из-за нарушения иерархии
* 401 запрос не авторизован
* 403 у пользователя нет доступа к курсу
* 404 курс/тег не найден
v1 > course-change-request > list
Описание
Перевод с курса на курс для 111 проекта
Получить список доступных ид курсов
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя,
имеющего доступ для редактирования курса
Пример запроса
GET /api/v1/course-change-request/?application_id=1&unti_id=222&course_id=123
Параметры GET запроса
* application_id - id заявки, обязательный параметр
* unti_id - unti_id пользователя, передается вместе с course_id
* course_id - id курса, передается вместе с unti_id
Пример ответа
* 200 {"avaliable_course_ids": [1,2,3]}
* 400 Не переданы unti_id + course_id или application_id
* 401 запрос не авторизован
* 403 у пользователя нет доступа к курсу
* 404 курс не найден
v1 > course-change-request > create
Описание
Перевод с курса на курс для 111 проекта
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя,
имеющего доступ для редактирования курса
Пример запроса
POST /api/v1/course-change-request/
Тело запроса
{
"course_id": 111,
"application_id": 2222,
}
Параметры POST запроса
* course_id - id курса в каталоге (int) или uuid в rall, обязательный параметр
* application_id - id заявки, обязательный параметр
Пример ответа
* 200 {"succes": True, "id": 123} - заявка
* 400 не передан обязательный параметр или такой набор тегов нельзя добавить из-за нарушения иерархии
* 401 запрос не авторизован
* 403 у пользователя нет доступа к курсу
* 404 Заявка не найдена
v1 > course-request > recsys-markup > create
Описание
Загрузка разметки от рексис для курса
Запрос должен содержать хедер x-plp-api-key
Пример запроса
POST /api/v1/course-request/recsys-markup/
Параметры post запроса
* id - id заявки
* markup - список uuidов узлов таксономии, возможно пустой список
Пример ответа
* {} если все ок
* 400 если не переданы обязательные параметры или они некорректны
* 403 если api key не указан или некорректен
* 404 если не найдена заявка
v1 > course-request > recsys-protocol > create
Описание
Загрузка протокола от рексис для заявки на участие в проекте
Запрос должен содержать хедер x-plp-api-key и иметь content-type: multipart/form-data
Пример запроса
POST /api/v1/course-request/recsys-protocol/
Параметры post запроса
* id - id заявки
* file - файл протокола
Пример ответа
* {} если все ок
* 400 если не переданы обязательные параметры или они некорректны
* 403 если api key не указан или некорректен
* 404 если не найдена заявка
v1 > course-transfert > dtrace-report > create
Описание
Передача информации об анализе рефлексии пользователя
Запрос должен содержать хедер x-plp-api-key
Пример запроса
POST /api/v1/course-transfert/dtrace-report/
Параметры post запроса
* unti_id - unti_id пользователя, int, обязательное поле
* project_id - id проекта, int, обязательное поле
* course_id - id курса, int, обязательное поле
* DT_answer1 - bool, обязательное поле
* DT_answer2 - bool, обязательное поле
* DT_answer3 - bool, обязательное поле
* Reflection - bool, обязательное поле
* report - json, обязательное поле
Пример ответа
* {} если все ок
* 400 если не переданы обязательные параметры или они некорректны, или заявка в подходящем статусе не найдена
* 403 если api key не указан или некорректен
v1 > digital-trace-for-course > list
Описание
API списка загруженных файлов для DTC
Запрос должен содержать хедер x-plp-api-key
Пример get запроса
GET /api/v1/digital-trace-for-course/
Параметры запроса
* dt_from - минимальная дата-время создания элемента, строка, опционально
* dt_to - минимальная дата-время создания элемента, строка, опционально
* element_type - id типа элемента, число, опционально
* id - id элемента, число, опционально
Пример ответа
* 200 {
"count": 1,
"next": "https://catalog/api/v1/digital-trace-for-course/?page=2",
"previous": null,
"results": []
}
* 403 если в запросе нет api key или он неверен
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
v1 > digital-trace-for-course > read
Описание
API для просмотра информации о загруженном цс
Запрос должен содержать хедер x-plp-api-key
Пример get запроса
GET /api/v1/digital-trace-for-course/1/
Пример ответа
* 200 {
"element": "reflection",
"element_file": https://catalog/media/digital_trace/file.csv,
"archive_structure": null,
"created_at": "2020-01-30T14:55:37.972723+03:00",
"status": "rework",
"rall_uuid": "qwerty",
"element_type_id": 1,
"project_id": 1,
"project_title": "проект",
"id": 1,
"project_id": 1,
"project_title": "project",
"element_type_title": "артефакт",
"course_lms_url": "http://example.com/course1",
"course_title": "course 1",
"course_id": 1,
"course_org_id": 1,
"is_check_mpc": true
}
* 403 если в запросе нет api key или он неверен
* 404 если цс с узаканным id не найден
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v1 > document-types > list > list
Описание
Список типов документов
Пример запроса
GET /api/v1/document-types/list/
Пример ответа
* 200 [
{
"title": "Test 1111",
"status": "published",
"uuid": "9c26ab1e-d062-4662-92a5-079e0156179b",
"sign_only": true,
"bind_flow": true,
"flow_status": "filled"
},
{
"title": "Test 2222",
"status": "published",
"uuid": "f695e9a7-b1e4-47fd-be87-40639ac94084",
"sign_only": false,
"bind_flow": false,
"flow_status": ""
}
]
* 401 запрос не авторизован
v1 > documents > change-visibility > create
Описание
Изменить видимость документа
Пример запроса
POST /api/v1/documents/change-visibility/
Параметры POST запроса
* doc_uuid - uuid документа (обязательный параметр)
* is_published - новая видимость документа (1 - опубликовать, 0 - скрыть)
Пример ответа
* 200 {
"success" True,
"error": null
}
* 400 переданные параметры не валидны
* 401 запрос не авторизован
v1 > documents > create > create
Описание
Создать черновик документа
Пример запроса
POST /api/v1/documents/create/
Параметры POST запроса
* org - uuid организации (обязательный параметр)
* doc_type_slug - тип загружаемого документа (см. API /api/v1/document-types/list/)
* comment - комментарий (опциональный параметр)
* flow_id - id потока, обязательно для определенных типов документов
Пример ответа
* 200 {
"success": True,
"doc_uuid": "uuid документа"
}
* 400 переданные параметры не валидны
* 401 запрос не авторизован
v1 > documents > file_download_url > create
Описание
Получить URL на скачивание документа
Пример запроса
POST /api/v1/documents/file_download_url/
Параметры POST запроса
* org - uuid организации (обязательный параметр)
* file_type - тип скачиваемого файла (доступные варианты: doc - основной файл, ds - ЭЦП)
* doc_uuid - uuid документа
Пример ответа
* 200 {
"success" True,
"download_url": "<ссылка на скачивание из S3>" // действительна час
}
* 401 запрос не авторизован
* 404 файл не найден
v1 > documents > file_upload_url > create
Описание
Получить URL на загрузку документа
Пример запроса
POST /api/v1/documents/file_upload_url/
Параметры POST запроса
* org - uuid организации (обязательный параметр)
* file_name - имя загружаемого файла
* file_type - тип загружаемого файла (доступные варианты: doc - основной файл, ds - ЭЦП)
* doc_uuid - uuid документа
Пример ответа
* 200 {
"success" True,
"upload_url": "<ссылка на загрузку в S3>", // действительна час
"file_uuid": "<uuid файла>",
"content_type": "Content-Type заголовок для загрузки в S3"
}
* 400 переданные параметры не валидны
* 401 запрос не авторизован
v1 > documents > get-related > list
Описание
Получить uuid подписанного документа
Пример запроса
GET /api/v1/documents/get-related/?doc_uuid=12341234-1234-1234-1234-123412341234
Параметры GET запроса
* doc_uuid - uuid документа (обязательный параметр)
Пример ответа
* 200 {
"doc_uuid" null,
}
* 400 не передан doc_uuid
* 401 запрос не авторизован
* 404 документ с указанным doc_uuid не существует
v1 > documents > list > list
Описание
Список документов, связанных с организацией
Пример запроса
GET /api/v1/documents/list/?org=test
Параметры GET запроса
* org - uuid организации (обязательный параметр)
* dt_from - фильтровать по дате создания "с" - iso format YYYY-MM-DDThh:mm:ss.fffff (опциональный параметр)
* dt_to - фильтровать по дате создания "до" - iso format YYYY-MM-DDThh:mm:ss.fffff (опциональный параметр)
* last_created - фильтровать по последному созданному типу для документа. В этом случае dt_to, dt_from передавать не надо
* display - входящие/исходящие/все - возможные варианты: 'sent', 'inbox', 'all' (по умолчанию 'all')
* flow_id - id потока (int), к которому привязан документ
* page - страница выдачи (по умолчанию 1)
Пример ответа
* 200 {
"num_pages": 1, // всего страниц
"total_count": 5, // всего документов
"page": 1, // текущая страница
"data": [
{
"title": "ыифвоифвоыиыфвиыфв",
"is_inbox": true, // входящий или исходящий документ
"doc_uuid": "53640ce8-751a-4c91-a9a4-6c4a73257b85",
"doc_type_title": "Test1111",
"doc_type_uuid": "f695e9a7-b1e4-47fd-be87-40639ac94084",
"ds_exists": false, // есть ли ЭЦП или нет
"comment": "",
"created_at": "2020-10-20T12:43:38.526472+00:00",
"creator_unti_id": 12,
"flow_id": null, // id потока, к которому привязан документ
"is_published": True, // документ опубликован или скрыт
"course_id": 1, // id курса
"project_id": 1, // id проекта
},...]}
* 400 переданные параметры не валидны
* 401 запрос не авторизован
* 403 у пользователя нет доступа к организации
* 404 организация не найдена
v1 > documents > publish > create
Описание
Опубликовать черновик документа
Пример запроса
POST /api/v1/documents/publish/
Параметры POST запроса
* doc_uuid - uuid документа (обязательный параметр)
Пример ответа
* 200 {
"title": "ыифвоифвоыиыфвиыфв",
"is_inbox": true, // входящий документ
"doc_uuid": "53640ce8-751a-4c91-a9a4-6c4a73257b85",
"doc_type_title": "Test1111",
"doc_type_uuid": "f695e9a7-b1e4-47fd-be87-40639ac94084",
"ds_exists": false, // есть ли ЭЦП или нет
"comment": "лываовыаиоывоа",
"created_at": "2020-10-20T12:43:38.526472+00:00",
"creator_unti_id": None
}
* 400 переданные параметры не валидны либо же не все файлы загружены
* 401 запрос не авторизован
v1 > documents > set-ds-status > create
Описание
Проставить валидность ЭЦП
Пример запроса
POST /api/v1/documents/set-ds-status/
Параметры POST запроса
* doc_uuid - uuid документа (обязательный параметр)
* is_valid - 0 или 1 - валидна ли подпись (1 - валидна)
* error - text - поясняющий текст, обязательно в случае ошибки эцп
Пример ответа
* 200 {}
* 400 не переданы обязательные параметры или у выбранного документа нет подписи
* 401 запрос не авторизован
* 404 документ с указанным doc_uuid не существует
v1 > export-course > create
Описание
Экспорт курса в каталог (как в сцос)
Запрос должен быть авторизован методом basic auth пользователем, являющимся администратором внешней платформы
Пример запроса
POST /api/v1/export-course/
Параметры post запроса см. схему
Пример ответа
* {"totalNumber": 1, "info": [{"course_id": "course"}]}
* 400 {"faultcode": "Client", "faultstring": "error: """}
* 401 если запрос не авторизован
* 403 если у пользователя нет прав для экспорта курса
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
id | |
title required | |
started_at required | |
finished_at required | |
enrollment_finished_at required | |
image required | |
description required | |
annotation | |
competences required | |
requirements required | |
content required | |
external_url required | |
direction required | |
institution required | |
duration required | |
lectures required | |
language required | |
cert required | |
visitors required | |
teachers required | |
transfers required | |
results required | |
accreditated required | |
hours required | |
hours_per_week required | |
business_version required | |
promo_url required | |
promo_lang required | |
subtitles_lang required | |
estimation_tools required | |
proctoring_service required | |
sessionid required | |
course_status |
v1 > export-course > update
Описание
Обновление информации о курсе в каталог (как в сцос)
Запрос должен быть авторизован методом basic auth пользователем, являющимся администратором внешней платформы
Пример запроса
PUT /api/v1/export-course/
Параметры post запроса см. схему
Пример ответа
* {"totalNumber": 1, "info": [{"course_id": "course"}]}
* 400 {"faultcode": "Client", "faultstring": "error: """}
* 401 если запрос не авторизован
* 403 если у пользователя нет прав для экспорта курса
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
id | |
title required | |
started_at required | |
finished_at required | |
enrollment_finished_at required | |
image required | |
description required | |
annotation | |
competences required | |
requirements required | |
content required | |
external_url required | |
direction required | |
institution required | |
duration required | |
lectures required | |
language required | |
cert required | |
visitors required | |
teachers required | |
transfers required | |
results required | |
accreditated required | |
hours required | |
hours_per_week required | |
business_version required | |
promo_url required | |
promo_lang required | |
subtitles_lang required | |
estimation_tools required | |
proctoring_service required | |
sessionid required | |
course_status |
v1 > export-requests > list
Описание
Экспорт заявок, поданных на участие в проекте “ЦП” организациями.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя
Пример запроса
GET /api/v1/export-requests/
Пример ответа
См. google документ
v1 > export-ticket-applications > list
Описание
Экспорт заявок, поданных слушателями на обучение в образовательных программах.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя
Пример запроса
GET /api/v1/export-ticket-applications/
Пример ответа
См. google документ
v1 > file_status_update > update
Описание
Изменение статуса проверки ЦС
Запрос должен содержать хедер x-plp-api-key
Пример get запроса
PUT /api/v1/file_status_update/<cat_id>/
Параметры запроса
* status - validated/error
* error_description - файл ошибки (в формате csv)
Пример ответа
* 200 {}
* если не зватает обязательных параметров или они некорректны
* 403 если в запросе нет api key или он неверен
* 404 цс не найден
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this course digital trace. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status required | |
error_description |
v1 > file_status_update > partial_update
Описание
Изменение статуса проверки ЦС
Запрос должен содержать хедер x-plp-api-key
Пример get запроса
PUT /api/v1/file_status_update/<cat_id>/
Параметры запроса
* status - validated/error
* error_description - файл ошибки (в формате csv)
Пример ответа
* 200 {}
* если не зватает обязательных параметров или они некорректны
* 403 если в запросе нет api key или он неверен
* 404 цс не найден
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this course digital trace. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status | |
error_description |
v1 > get-file-download-link > create
Описание
Получение подписанной ссылки на загрузку файла из приватного бакета
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора
Пример запроса
POST /api/v1/get-file-download-link/
Параметры post запроса
* type - тип объекта (projectparticipationrequest), обязательный параметр
* id - id объекта, обязательный параметр
* field - имя поля с файлом, обязательный параметр
Пример ответа
* {
"url": ""
}
* 400 если не переданы обязательные параметры или они некорректны
* 401 если запрос не содержит токен
* 403 если у пользователя нет доступа
* 404 если файл не найден
v1 > kafka-proxy > digital-trace > create
Описание
Проксирование передачи ЦС в кафка
Запрос должен содержать хедер x-plp-api-key
Пример запроса
POST /api/v1/kafka-proxy/digital-trace/{
"actor_unti_id": 1,
"CourseId": 1,
"FlowId": 1,
"FuturecodeModuleId": 1,
"ProjectId": 1,
"MessageType": "RRecipients",
"RegistryData": {},
"action_type": ""
}
Параметры post запроса
* actor_unti_id - unti_id пользователя, int, обязательное поле
* CourseId - ИД курса, int, обязательное поле
* FlowId - ИД потока, int, обязательное поле
* FuturecodeModuleId - ИД типа ЦС, int, обязательное поле
* ProjectId - ИД проекта, int, обязательное поле
* RegistryData - json, обязательное поле
* MessageType - Тип сообщения, String, обязательное поле, возможные значения: RRecipients/RTransferts/RLearnersPath/RDigitalTraces/RDigitalTraces_1...RDigitalTraces_10
* action_type - string, необязательное поле, возможные значения: create, update, delete. Default - create.
Пример ответа
* 200 если все ок
* 400 если не переданы обязательные параметры или они некорректны
* 404 actor_unti_id, курс, поток, проект,
* 403 если api key не указан или некорректен
v1 > learningflow > enroll > status > accepted > create
Описание
Изменить видимость документа
Пример запроса
POST /api/v1/learningflow/enroll/status/accepted/
Параметры POST запроса
* application_id - id заявки
* status - (1 = успех, 2 = ошибка)
* error - текст ошибки
Пример ответа
* 200 {
'success': True
}
* 400 нет такой заявки на смену статуса или указаны не валидные параметры
* 401 запрос не авторизован
v1 > org > list
Описание
Просмотр списка организаций.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
GET /api/v1/org/
Параметры запроса
Можно использовать следующие параметы для фильтрации списка (все параметры не обязательны):
* application_status - статус заявки (возможные значения: подана, одобрена, отклонена),
* application_created_at_before - максимальное время создания заявки в формате ISO 8601 datetime
* application_created_at_after - минимальное время создания заявки в формате ISO 8601 datetime
* application_project_id - ID проекта
Пример ответа
{
"count": 1,
"next": null,
"previous": null,
"results": [...] // список объектов того же формата, как при запросе одной организации
}
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
application_created_at | |
application_status | |
application_project_id |
v1 > org > read
Описание
Просмотр конкретной организации по ее uuid.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
GET /api/v1/org/ea0108d6-d204-4d85-a6e5-2831e71695db/
Пример ответа
{
"title": "Организация", // Название краткое
"contact_person": "Иван Иванович", // ФИО контактного лица
"email": "user@exmaple.com", // E-mail контактного лица
"phone": "84951234567", // Телефон контактного лица
"site": "https://example.com", // Ссылка на сайт
"logo": "https://example.com/logo.jpg", // Логотип образовательной организации
"extended_data": {
"legal_name": "Юридическое название", // Название юридическое
"inn": "", // ИНН
"kpp": "", // КПП
"ogrn": "", // ОГРН
"license_number": "", // Номер лицензии на осуществление образовательной деятельности
"license_date": "2020-01-01", // Дата лицензии на осуществление образовательной деятельности
"license_file": "https://example.com/file.pdf", // Лицензия (ссылка на файл)
"no_debts_confirmation": "https://example.com/file.pdf", // Декларация соответствия образовательной организации (ссылка на файл)
"bank_bik": "", // БИК
"bank_name": "", // Наименование банка
"rs": "", // Расчетный счет
"ks": "", // Корреспондентский счет
"ufk": "", // Лицевой счет
"sign_name": "", // ФИО Подписанта
"sign_reason": "устав", // Основание для подписания
"post": "", // Должность подписанта
"proxy_number": "", // Номер доверенности
"proxy_date": null, // Дата доверенности
"order_number": "", // Номер приказа
"order_date": null, // Дата приказа
"legal_address": "", // Юридический адрес
"physical_address": "", // Фактический адрес
"authority_confirmation": null, // Подтверждение полномочий (ссылка на файл)
"uuid": "8ef3fad4-ea5f-445f-85cd-ca81079766ce", // UUID организации
"has_signature": false, // у образовательной организации есть электронная цифровая подпись
"is_ie": false, // Организация является ИП
"egrip_ie_date": null, // Лист записи ЕГРИП, дата внесения записи о приобретении статуса ИП
"egrip_tax_authority": "", // Лист записи ЕГРИП, выдан налоговым органом
"egrip_gov_number": "", // Лист записи ЕГРИП, государственный номер
"apkit_confirmation": "", // Подтверждение членства или ассоциированного членства Организации в АПКИТ
"software_confirmation": "", // Подтверждение сертификации учебного центра по российскому программному обеспечению
},
"id": 2, // ID организации
"owner_unti_id": null, // Unti-id владельца
"owner_leader_id": null, // Leader-id владельца
"date_created": "2019-09-30 16:10:38.494714+00:00", // Дата создания организации
"org_application": { // актуальная заявка организации, если есть
"status": "подана", // статус
"created_at": "2020-10-03 14:58:47.066564+00:00", // когда подана
"status_changed_at": null, // когда изменен статус
"reason": "", // причина отклонения заявки
"role": "edu", // роль организации
"type": "bas_dpo", // тип bas_dpo, bas_dpo_2025 или pdc
"additional_status": "", // дополнительный статус (если есть)
"questionnaire": { // Заявка на участие в программе КЦЭ (если есть)
"uuid": "", // uuid документа
"ds": true, // если есть отдельный файл эцп
}
}
}
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
* 404 если заявка не организация
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
extended_params__uuid required |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
application_created_at | |
application_status | |
application_project_id |
v1 > org > application > update
Описание
Изменение статуса заявки организации. Статус можно изменить только если текущий статус заявки "подана".
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
PUT /api/v1/org/<uuid>/application/
Параметры запроса * project_id - ID проекта, обязательный параметр * status - новый статус, обязательный параметр, возможные значения: "одобрена", "отклонена" * reason - причина отклонения заявки, необязательный паарметр * additional_status - дополнительный статус, можно проставить только после принятия заявки. Возможные значения: "contract_signed", "register_signed", "payment_received". Последние 2 можно проставить только работодателям
Пример ответа
* 200 если статус успешно изменен
* 400 если статус заявки нельзя изменить или переданы некорректные параметры
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
* 404 организация не найдена или организация не подавала заявку
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
uuid required |
v1 > pcs > check_promocode > create
Описание
Проверка промокода для ЦП
Запрос должен содержать хедер x-plp-api-key
Пример запроса
POST /api/v1/pcs/check_promocode/
Параметры post запроса
* last_name - фамилия, обязательный параметр
* first_name - имя, обязательный параметр
* second_name - отчество
* snils - снилс, обязательный параметр
* promocode - промокод, обязательный параметр
* unti_id - unti_id, обязательный параметр
Пример ответа
* {
"success":true,
"employer_title":"Организация",
"employer_id": 1,
"tag":"allintime"
}
* 400 если не переданы обязательные параметры или они некорректны
* 403 если api key не указан или некорректен
* 404 если промокод/пользователь/какая-то связка не найдена
v1 > pcs > course-scoring > create
Описание
Проставление скоринга по заявке на участие курса в проекте
Запрос должен содержать хедер x-plp-api-key или "Authorization: Token ***" с токеном пользователя
Пример запроса
POST /api/v1/pcs/course-scoring/
Параметры post запроса
* requestId - id заявки, обязательный параметр
* code - строка, "CLONE"
* resolution - строка, возможные значения OK/NOTOK
* cloneRequestId - id заявки-клона, если resolution == NOTOK
Пример ответа
* 201 {} если все ок
* 400 если не переданы обязательные параметры или они некорректны
* 403 если api key не указан или некорректен, или пользователь не является администратором
v1 > pcs > get-user-employer > list
Описание
Получение работодателя для пользователя
Запрос должен содержать хедер x-plp-api-key
Пример запроса
GET /api/v1/pcs/get-user-employer/?unti_id=1
Параметры post запроса
* unti_id - unti_id, обязательный параметр
Пример ответа
* {
"employer_title":"Организация",
"employer_id": 1,
}
* 400 если не переданы обязательные параметры или они некорректны
* 403 если api key не указан или некорректен
* 404 если пользователь не найден
v1 > pcs > set-course-price > create
Описание
Простановка цен курса для разных категорий пользователей
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора
Пример запроса
POST /api/v1/pcs/set-course-price/{
"request_id": 1
"prices": {
"full": 30000, // полная цена курса
"dicert_2021_true": 15000,
"dicert_company": 100000
}
}
Параметры post-запроса
* request_id - id принятой заявки на добавление курса в проект, обязательный параметр
* prices - словарь с ценами, обязательный параметр. Должен обязательно включать ключ "full" для
полной цены курса, а также цены для разных категорий пользователей
Пример ответа
* 200 или 201, в зависимости от того, создан или обновлен объект
* 400 если параметры некорректны
* 401 если запрос не содержит токен
* 403 если у пользователя нет доступа
* 404 если заявка не найдена
v1 > planguage > list
Описание
Список языков программирования
Запрос должен содержать хедер "x-api-key" с ключом доступа
Пример запроса
GET /api/v3/planguage/
Пример ответа
* {
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id" : 1
"slug": "slug",
"name": "name",
}
]
}
* 403 если не передан api key или он неверен
* 404 если передан некорректный проект
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
v1 > project > read
Описание
Информация о ключевых датах проекта
Запрос должен содержать хедер x-plp-api-key
Пример запроса
GET /api/v1/project/1/
Пример ответа
* {
"check_edu_org_start": null,
"check_edu_org_end": null,
"check_employer_org_start": null,
"check_employer_org_end": null,
"check_students_start": null,
"check_students_end": null,
"check_courses_start": null,
"check_courses_end": null,
"employer_list_end": null,
"individual_student_request_end": null,
"course_payment_end": null,
"course_access_open": null
}
* 403 если api key не указан или некорректен
* 404 если проект не найден
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Проект. |
v1 > set-agreement-num > list
Описание
Добавление номера договора к принятой заявке на участие курса в проекте
Запрос должен быть авторизован токеном служебного пользователя
Пример запроса
GET /api/v1/set-agreement-num/?request_id=1&agreement_num=agreement&date=2019-12-31
Параметры get запроса * request_id - id заявки, число, обязательный параметр * agreement_num - номер договора, обязательный параметр * date - дата принятия договора в формате %Y-%m-%d, обязательный параметр
Пример ответа
* 200 если все ок
* 400 {"error": "description"}, если не переданы обязательные параметры или они некорректны,
или заявка еще не принята
* 401 если запрос не авторизован
* 403 если у пользователя нет статуса персонала
v1 > ticket_application > list
Описание
Просмотр заявок на курсы.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
GET /api/v1/ticket_application/
Параметры запроса
Можно использовать следующие параметы для фильтрации списка (все параметры не обязательны):
* project_id - id проекта
* unti_id - unti_id пользователя
* course_id - id курса
* status - статус заявки, возможные значения: review, approved, approved_employer, accepted,
admitted, declined, expelled, not_admitted, finished
* status__in - статус заявки (множественный выбор), возможные значения: review, approved, approved_employer, accepted,
admitted, declined, expelled, not_admitted, finished через запятую без пробелов
* has_course_ref - пройдена ли рефлексия по курсу, о или 1
* has_modules_ref - пройдена рефлексия по всем модулям, 0 или 1
* reason_choice - причина отчисления, legitimate/not_legitimate
Пример ответа
{
"count": 1,
}
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
* 503 если будут проблемы на стороне SSO
v1 > user > course-list > list
Описание
Получение списка курсов для пользователя по указанному unti_id
Запрос должен содержать хедер x-plp-api-key
Пример запроса
GET /api/v1/user/course-list/?unti_id=222&date_from=2020-10-16&date_to=2020-10-17&project_id=1&status=review,accepted,cancelled
Параметры get запроса
* unti_id - unti_id пользователя, число, обязательный параметр
* project_id - id проекта, число
* status - набор статусов через запятую, с которыми вернуть курсы пользователя
* date_from - дата с которой фильтровать записи пользователя на курс в формате %Y-%m-%d
* date_to - дата до которой фильтровать запись пользователя на курс в формате %Y-%m-%d
Пример ответа
* [{
"rall_uuid": "00000000-0000-0000-0000-000000000000",
"course_id": 1,
"title": "course",
"org_title": "title",
"url": "http://example.com",
"enroll_date": "10.02.2020",
"is_finished": true,
"finish_confirmed": true,
"has_reflection": true,
"project_id": 1,
"status": "accepted",
"reason_choice": "",
"full_price": null,
"user_price": null,
"test_link": "http://test-lms.ru",
"lms_url": "http://test.ru",
"reflection_link": "",
}]
* 200 если все ок
* 404 [], если с указанным unti_id пользователя не сушествует
* 403 если не передан api key
v1 > user > reflection > list
Описание
Проверка прохождения пользователем рефлексии
Запрос должен быть авторизован токеном
Пример запроса
GET /api/v1/user/reflection/?unti_id=222&course_uuid=12341234-1234-1234-1234-1234123412341234
Параметры get запроса * unti_id - unti_id пользователя, число, обязательный параметр * course_uuid - uuid курса, обязательный параметр
Пример ответа * { "has_reflection": true, "dt": "2020-11-11T11:06:07+00:00", "modules_count": 2, "modules_with_reflection_count": 0 } * 400 если не переданы обязательные параметры * 401 если запрос не авторизован * 404 если не найден пользователь/курс
v2 > course > read
Описание
Информация о курсе, его модулях и т.д.
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора
Пример запроса
GET /api/v2/course/1/
Пример ответа
* см. гугл док с составом полей
* 401 если запрос не содержит токен
* 403 если у пользователя нет доступа
* 404 если курс не найден
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
v2 > course > enroll > create
Описание
Изменение статуса заявки на курс
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример post запроса
POST /api/v2/course/enroll/{
"platform_id": "platform",
"unti_id": 1
"external_course_id": "course",
"status": "expelled",
"reason": "exam_failed"
}
Параметры post запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - unti_id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр
* status - новый статус, обязательный параметр. Возможные значения: declined - отклонена,
approved - одобрена, expelled - отчисление
* reason - причина отчисления, обязательно если status == "expelled". Возможные значения:
no_exam - Не дошёл до итоговой аттестации,
exam_failed - Неудовлетворительно сдал итоговую аттестацию
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры или нельзя изменить статус
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс/заявка
v2 > course > set-finished > create
Описание
Проставление пользователю статуса окончившего курс
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример post запроса
POST /api/v2/course/set-finished/{
"platform_id": "platform",
"unti_id": 1
"course_id": 1
}
Параметры post запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* course_id - индентификатор курса, обязательный параметр
* education_end_date - дата окончания обучения в формате "%Y-%m-%d", обязательный параметр
* qualification_doc_number - номер бланка документа о квалификации, строка, обязательный параметр
* qualification_doc_registration_number - регистрационный номер документа о квалификации, строка, обязательный параметр
* frdo_number - номер ФРДО, строка, обязательный параметр
* quailfication_doc_date - дата выдачи документа о квалификации в формате "%Y-%m-%d", обязательный параметр
* expulsion_order_date - дата приказа об отчислении в формате "%Y-%m-%d", обязательный параметр
* expulsion_order_number - номер приказа об отчислении, строка, обязательный параметр
Пример ответа
* 201 если запись успешно обновлена
* 400 если не хватает параметров в запросе или они некорректны
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс/заявка
* 412 пользователь не записан на курс или отметка об окончании курса уже проставлена
* 417 не удалось проставить статус
v2 > export-course > create
Описание
Создание/обновление курса по запросу LMS
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора внешней платформы
Пример запроса
POST /api/v2/export-course/
Параметры post запроса
* platform_id - код внешней платформы, обязательный параметр
* external_course_id - id курса во внешней системе, обязательный параметр
* account_id - id организации во внешней системе, обязательный параметр
* title - название курса, обязательный параметр
* description - описание
* image - ссылка на изображение
* session_url - ссылка на курс, обязательный параметр
Пример ответа
* 200 если запрос успешно обработан, параметр id в ответе - внутренний id курса в каталоге
* 400 если переданные параметры некорректны или курс недоступен для редактирования
* 401 если запрос не авторизован
* 403 если пользователь не является администратором платформы
v2 > export-requests > list
Описание
Просмотр заявок на участие курсов в проектах.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
GET /api/v2/export-requests/
Параметры запроса
Можно использовать следующие параметы для фильтрации списка (все параметры не обязательны):
* project_id - id проекта
* status - статус заявки (возможные значения: подана, одобрена, отклонена, отменена, отозвана),
* created_at_before - максимальное время создания заявки в формате ISO 8601 datetime
* created_at_after - минимальное время создания заявки в формате ISO 8601 datetime
* status_changed_at_before - максимальное время изменения статуса заявки в формате ISO 8601 datetime
* status_changed_at_after - минимальное время изменения статуса заявки в формате ISO 8601 datetime
* inspection_protocol2_dt_before - максимальное время добавления второго протокола в формате ISO 8601 datetime
* inspection_protocol2_dt_after - минимальное время добавления второго протокола в формате ISO 8601 datetime
* approved_by_employers - заявки, курсы которых получили 2 и больше лайков от работодателей.
Допустимые значения True, False (обязательно с большой буквы)
* scoring_status - фильтрация по статусу определенного типа скоринга, например "CLONE-OK"
* received_all_scorings - получены результаты всех скорингов. Допустимые значения True, False
(обязательно с большой буквы)
Пример ответа
{
"count": 1,
"next": null,
"previous": null,
"results": [...] // список объектов того же формата, как при запросе одной заявки
}
* 400 если неправильно задан параметр фильтрации
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
status | |
created_at | |
project_id | |
review_status | |
status_changed_at | |
inspection_protocol2_dt | |
approved_by_employers | |
scoring_status | |
received_all_scorings |
v2 > export-requests > read
Описание
Просмотр конкретной заявки на участие курса в проекте.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
GET /api/v2/export-requests/1/
Пример ответа
{
"files": [ // список урлов файлов из заявки
{
"file_obj": "http://example.com/file.pdf",
},
{
"file_obj": "http://example.com/file2.pdf",
}
],
"economic_area": "", // Выбранная область
"comment": "qwe", // Комментарий
"project_title": "qwe", // Название проекта
"project_id": 1, // ID проекта
"id": 1, // ID заявки
"org_uuid": "2aec4e56-9510-4ce7-8c8d-09316a5a2e66", // UUID организации
"org_id": 3, // ID организации
"creator_leader_id": "1", // leader-id человека направившего заявку
"created_at": "2019-10-18T20:16:15.497159+03:00", // Дата подачи заявки
"status": "отклонена", // Статус заявки
"review_status": null, // Статус рассмотрения (null/взято в проверку/проверка завершена)
"status_changed_at": "2019-10-18T20:25:26.455387+03:00", // Дата проверки заявки
"reason": "", // Причина отказа
"expert_manager": { // Ответственный за проверку эксперт
"full_name": "jvtWv RcLQA FACiB",
"email": "user3@qwe.qwe",
"unti_id": "5"
},
"expert_user": { // эксперт
"full_name": "jvtWv RcLQA FACiB",
"email": "user3@qwe.qwe",
"unti_id": "5"
},
"inspection_protocol": "http://example.com/file.xlsx", // Неподписанная сылка на протокол проверки
"review_start": "2020-10-10T17:10:12.617290+03:00", // Дата начала проверки
"review_end": "2020-10-10T18:18:54.978490+03:00", // Дата окончания проверки
"inspection_protocol2": "http://example.com/file.xlsx", // Неподписанная ссылка на второй протокол проверки
"inspection_protocol2_dt": "2020-10-10T17:10:12.617290+03:00", // Дата добавления второго протокола
"protocol_signature": "http://example.com/file.xlsx", // Неподписанная сылка на ЭЦП
"protocol2_signature": "http://example.com/file.xlsx", // Неподписанная сылка на ЭЦП
"conclusion": "valid", // Заключение
"score": 9, // Баллы
"check_formal": true,
"check_summary": false,
"protocol_validation_date": "2025-02-11T00:00:00+03:00",
"protocol_validation_number": "112",
"provider_declared_price": "13.90",
"demand_price_correlation": "",
"course": {
"title": "asd", // Название
"about": "", // Описание
"description": "", // Аннотация
"points": null, // Трудоёмкость в зачётных единицах
"price": 14, // Стоимость программы
"results": "", // Планируемые результаты обучения
"edx_url": "https://google.com", // Страница обучения на курсе
"specifications": "", // Требования к слушателям и пререквизиты
"additional_info": "", // Дополнительная информация
"cover": "http://example.com/media/cover/course.jpg", // Обложка (картинка для отображения в каталоге)
"date_created": "2019-09-30 19:51:54.551684+00:00", // Дата создания курса
"id": 14, // ID курса
"extended_params": {
"course_format": "online", // Формат обучения
"difficulty_level": null, // Уровень сложности
"hours": 0, // Количество академических часов
"goal": "", // Цель программы
"lms_url": "", // Страница о подробной информации курса
"test_link": "", // Ссылка на прохождение входной диагностики
"document": "", // Выдаваемый документ по окончанию
"min_participants": 0, // Минимальное количество человек на одном потоке курса
"max_participants": 0, // Максимальное количество человек на одном потоке курса
"contact_person": "", // Контактное лицо
"contact_email": "", // Контактное лицо (маил)
"contact_phone": "", // Контактное лицо (телефон)
"bas_theory_academic_hours":0, // Объем образовательного теоретического блока в академических часах
"bas_practice_academic_hours":0, // Объем блока практической подготовки в академических часах
"bas_practice_format":"", // Формат блока практической подготовки
"bas_academic_hours_price":0, // Стоимость академического часа
"bas_commerce_price":0, // Стоимость обучения по образовательной программе на коммерческой основе
"bas_academic_hours_commerce_price":0, // Стоимость академического часа по образовательной программе на коммерческой основе
"bas_success_finished_users":0, // Данные о количестве слушателей, ранее успешно прошедших обучение по образовательной программе
"bas_customer_company_name":"", // Наименовании компании-заказчика
"bas_number_required_specialists":0, // Количество требуемых специалистов
"bas_positions_required_specialists":"", // Должности требуемых специалистов
"bas_raex_rating":0, // Указание на позицию в предметном рейтинге RAEX («РАЭКС-Аналитика») «Авиационная и ракетно-космическая техника» за 2023 год (при условии, если провайдер входит в указанный рейтинг)
"bas_review_aeronext":"", // Рецензия на программу, предоставленная компанией, входящей в реестр членов Ассоциации работодателей и предприятий индустрии беспилотных авиационных систем «АЭРОНЕКСТ» (при наличии)
"bas_user_education":"", // Образование
"bas_no_entry_test":false, // Входное тестирование не предусмотрено
"regions": [ // Регионы
{
"name": "Москва",
"okato_code": "45000000000"
}
],
"bas_all_regions":false, // Реализация обучения на всей территории РФ
"bas_fgos":"", // Указание ФГОС, профессионального стандарта, квалификационных требований
"bas_education_aims":"", // Планируемые результаты обучения в соответствии со сферой БАС
"bas_track_section":"", // Разделы (модули, темы) образовательной программы, в рамках освоения которых обеспечивается формирование компетенций в соответствии с требованиями к треку (указывается для каждой компетенции)
"bas_tools_practice":"", // Оборудование, инструменты, используемые для обучения и практической подготовки с учетом типов (элементов) БАС в соответствии с требованиями к треку
"bas_software_tools":"", // Программное обеспечение, используемое для обучения
"bas_unique_skills":"", // Разделы (модули, темы) образовательной программы, в рамках освоения которых обеспечивается формирование (совершенствование) специфичных (уникальных) знаний, навыков, умений в соответствии с требованиями к треку
"bas_commission_characteristics" : "", // Характеристика кадрового состава аттестационной комиссии
"bas_place_description": "", // Описание места проведения
"study_direction": "Искусственный интеллект", // Направление обучения
"start_date_education_programm": "", // Дата начала освоения Образовательной программы
"completion_date_education_programm": "", // Дата завершения освоения Образовательной программы
"formic_basic_ai_skills": "", // Формируемые базовые навыки в области искусственного интеллекта
"modules_number_kids": "", // Количество модулей
"final_assessment_lower_scale_initial_level": "", // Итоговый контроль/Итоговая аттестация. Шкала оценивания, нижнее значение - Уровень начальный
"final_assessment_upper_scale_initial_level": "", // Итоговый контроль/Итоговая аттестация. Шкала оценивания, верхнее значение - Уровень начальный
"final_assessment_minimum_score_initial_level": "", // Итоговый контроль/Итоговая аттестация. Шкала оценивания, минимальный проходной балл - Уровень начальный
"target_audience": "", //
"type_educational_program": "", //
"kids_skills": "", //
"kids_tools": "", //
"kids_course_consist": "", //
"brief_description_platform": "", //
"block_one_name_key_feature": "", //
"block_two_name_key_feature": "", //
"block_three_name_key_feature": "", //
"kids_tools_technologies": "", //
"link_demo_course_one": "", //
"link_demo_course_two": "", //
"link_demo_course_three": "", //
}
},
"scoring": [ // результаты скорингов
{
"code": "CLONE",
"resolution": "NOTOK", // OK или NOTOK
"clone_request": 1, // id похожей заявки (для code "CLONE" при resolution "NOTOK")
"comment": "" // название организации и курса похожего курса (для code "FIN" при resolution "NOTOK")
}
],
"course_certifications":[ // Практические задания аттестации
{
"bas_certification_type": "final",
"module": 1,
"bas_task_title": "test",
"bas_task_description": "test",
"bas_object_description": "test",
"bas_materials_list": "test",
"bas_software_list": "test",
"bas_desctiption_criteria": "test"
}
],
"bas_program_type": "test",
"bas_sphere": "test",
"bas_track":"test",
"course_conditions":[ // Материально-технические условия реализации программы
{
"id":50,
"condition_type":"theory",
"location":"тест1",
"juridical":"тест2",
"infrastructure":"тест3"
}
],
}
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
* 404 если заявка не найдена
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Заявка на участие в проекте. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
status | |
created_at | |
project_id | |
review_status | |
status_changed_at | |
inspection_protocol2_dt | |
approved_by_employers | |
scoring_status | |
received_all_scorings |
v2 > export-requests > update
Описание
Изменение статуса заявки. Статус может быть изменен на "отозвана", если заявка находится в статусе
"одобрена" или на статусы "одобрена"/"отклонена ...", если она в статусе "подана". Подробнее статусы
для отклонения заявки перечислены в параметрах запроса
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
PUT /api/v2/export-requests/1/
Параметры запроса
* status - новый статус, возможнные значения: "одобрена", "отклонена по формальным критериям",
"отклонена по содержательным критериям", "отказ по цене", "отзыв до окончания экспертизы",
"отзыв после окончания экспертизы", "отозвана", "отклонена" (недоступно для проекта ЦП)
* reason - причина отклонения заявки, необязательный паарметр
* review_status - статус рассмотрения заявки, возможное значение - "допущено к проверке"
* program_file_url - url файла программы
Можно проставить или статус заявки с причиной отклонения, или статус рассмотрения заявки
Пример ответа
* 400 если статус не может быть изменен
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
* 404 если заявка не найдена
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Заявка на участие в проекте. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
status | |
created_at | |
project_id | |
review_status | |
status_changed_at | |
inspection_protocol2_dt | |
approved_by_employers | |
scoring_status | |
received_all_scorings |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status | |
review_status | |
reason | |
program_file_url | |
conclusion | |
score | |
check_formal | |
check_summary | |
protocol_validation_date | |
protocol_validation_number | |
provider_declared_price | |
demand_price_correlation |
v2 > export-requests > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Заявка на участие в проекте. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
status | |
created_at | |
project_id | |
review_status | |
status_changed_at | |
inspection_protocol2_dt | |
approved_by_employers | |
scoring_status | |
received_all_scorings |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status | |
review_status | |
reason | |
program_file_url | |
conclusion | |
score | |
check_formal | |
check_summary | |
protocol_validation_date | |
protocol_validation_number | |
provider_declared_price | |
demand_price_correlation |
v2 > set-course-price > create
Описание
Простановка цен курса для разных категорий пользователей
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора
Пример запроса
POST /api/v2/set-course-price/{
"course_id": 1
"prices": {
"full": 30000, // полная цена курса
"dicert_2021_true": 15000,
"dicert_company": 100000
}
}
Параметры post-запроса
* course_id - id курса, обязательный параметр
* prices - словарь с ценами, обязательный параметр. Должен обязательно включать ключ "full" для
полной цены курса, а также цены для разных категорий пользователей
Пример ответа
* 200 или 201, в зависимости от того, создан или обновлен объект
* 400 если параметры некорректны
* 401 если запрос не содержит токен
* 403 если у пользователя нет доступа
* 404 если заявка не найдена
* 406 если курс участвует в пцс
v2 > ticket_application > list
Описание
Получение списка заявок по платформе
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример get запроса
GET /api/v2/ticket_application/
Параметры get запроса
* platform_id - индентификатор платформы, обязательный параметр
* course_id - индентификатор курса
* unti_id - индентификатор пользователя
Пример ответа
{
"unti_id": 1,
"id" 1,
"futurecode_module_id": 1,
"futurecode_module_num": 1,
"status": "review",
"transfert_status": "",
"admission_order_number": 1,
"admission_order_date": "2022-11-11",
"expulsion_order_date": "2022-11-11",
"course_id": 1,
"flow_id": 1,
"flow_num": 1,
"pgu_id": 1,
"pgu_dt": "2022-11-11"
"service_okato": "",
"algorithm_grade": 123,
"language_grade": 123,
"motivation_grade": 123,
"applied_at": "2022-11-11 12:00:00",
"end_dt": "2022-11-11 12:00:00",
"untill_dt": "2022-11-11 12:00:00",
"difficulty_level": "intermediate",
"cof_exit_exam_status": "",
"exit_motivation_grade": 1,
"exit_algorithm_grade": 1,
"exit_language_grade": 1,
"is_timeout": true,
"exit_end_dt": "2022-11-11 12:00:00",
"certificate_url: "",
"certificate_number": ""
}
* 400 если не хватает параметров в запросе или они не верны
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
v3 > course > list
Описание
Список id курсов, участвующих в определенном проекте
Запрос должен содержать хедер "x-api-key" с ключом доступа
Параметры get-запроса
* project_id - int - id проекта, обязательный параметр
* org_id - int - id организации, необязательный параметр
Пример запроса
GET /api/v3/course/?project_id=48
Пример ответа
* {
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 109,
"published_at": "2022-03-10T19:01:12.096585+03:00",
"updated_at": "2022-03-10T19:01:12.096585+03:00",
"price": 30000,
"is_epgu": false,
"name": "курс",
"url": "http://example.com",
"org_name": "123",
"org_id": 17,
"epgu_rating": 120,
"date_start": "2022-03-02",
"additional_set_epgu": false,
"basic_level_info_kids": false,
"first_level_info_kids": false,
"advanced_level_info_kids": false,
"bas_program_parent_type": "19cf13a7-338c-4003-bf75-b32344e98660:ВОП - уровень 1"
}
]
}
* 403 если не передан api key или он неверен
* 404 если передан некорректный проект
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
v3 > course > read
Описание
Информация о курсе, участвующем в проекте ЦП, его модулях и т.д.
Запрос должен содержать хедер "x-api-key" с ключом доступа
Пример запроса
GET /api/v3/course/1/
Пример ответа
* {
"title": "Test",
"specifications": "Test",
"description": "Test",
"edx_url": "http://test.ru",
"results": "result",
"additional_info": "info",
"price": "100",
"economic_area": null,
"cover": "https://test.ru/cover/117.1679904892.jpg",
"is_epgu": false,
"course_competences": [],
"course_learning_flows": [
{
"id": 8309,
"flow_num": 1,
"date_start": "2023-12-11",
"date_end": "2024-12-31",
"is_filled": false,
"is_ended": false,
"is_active": true
}
],
"modules": [],
"instructors": [],
"course_scenario": null,
"org_id": 117,
"org_name": "ОО_тест123",
"programming_language": null,
"taxonomy_tags": [],
"addresses": [],
"course_format": "mixed",
"create_method": "simple_arm",
"course_level": "other",
"goal": "Test",
"hours": 250,
"lessons": 0,
"hours_week": 0,
"you_will_know": "",
"you_will_be_able": "",
"document": "",
"document_choice": "certificate",
"min_participants": null,
"max_participants": null,
"stsos_specified_data": null,
"version": 1,
"external_id": "29423",
"always_can_enroll": false,
"has_integration": true,
"create_ticket_application": false,
"ticket_application_status": "accepted",
"enrollments_by_ticket_limited": false,
"enrollments_by_ticket_num": 0,
"taxonomy_markup": false,
"moderation_status": "moderation",
"reflection_link": "",
"test_link": "http://test-lms.ru",
"no_diagnostics_check": false,
"place": "Москва",
"lms_url": "http://test.ru",
"applications_deadline": "2024-11-11",
"allow_edit_course": null,
"can_unenroll": false,
"unenroll_deadline": null,
"unenroll_days": null,
"difficulty_level": null,
"contact_person": "",
"contact_email": "",
"contact_phone": "",
"contact_post": "",
"use_reflection": true,
"diagnostics_controls": "Форма1",
"diagnostics_instruments": "Инструмент1",
"diagnostics_evaluation": "Test",
"diagnostics_scale": "Шкала1",
"diagnostics_hours": 100,
"attestation_hours": 100,
"attestation_controls": "Форма№1",
"attestation_tools": "Инструмент2",
"attestation_evaluation": "Test",
"attestation_scale": "Шкала2",
"requirements_education": [
"higher",
"secondary"
],
"requirements_qualification": "Квалификация№1",
"no_requirements_qualification": false,
"requirements_experience": "Опытный",
"no_requirements_experience": false,
"requirements_prereqs": "Test",
"no_requirements_prereqs": false,
"requirements_competentions": "Владею",
"no_requirements_competentions": false,
"no_specifications": false,
"program_version": "",
"program_date": null,
"graduates_number": null,
"cover_ok": true,
"relevance": "",
"prof_standard_code": "",
"fgos_code": "",
"fgos_title": "",
"prof_standard_name": "",
"first_course_confirmation": true,
"course_rating": null,
"reviews_count": null,
"reviews_link": "",
"course_recommended_for": "",
"disability": null,
"no_disability": false,
"specialization": "",
"industry": "Transport",
"additional_set_epgu": false,
"epgu_rating": 0,
"about_course_kids": "Test",
"demand_kids": "Test",
"university_admission_bonus_kids": "Test",
"course_format_kids": "Test",
"course_requirements_kids": "Test",
"rutube_url_kids": "https://test.ru/man",
"timetable_link_kids" : "https://test.ru/man",
"basic_level_info_kids": {"first_module_title": "test1", "second_module_title": "test2", "third_module_title": "test3", "fourth_module_title": "test4"},
"first_level_info_kids": {"first_module_title": "test1", "second_module_title": "test2", "third_module_title": "test3", "fourth_module_title": "test4"},
"advanced_level_info_kids": {"first_module_title": "test1", "second_module_title": "test2", "third_module_title": "test3", "fourth_module_title": "test4"},
"course": 29423,
"creator": 2510,
"platform": 11,
"diagnostics": null,
"language": null,
"reflection_type": null,
"module_reflection_type": null,
"basic_event_place": "Test",
"basic_learning_outcomes": "Test",
"basic_additional_information": "Test",
"basic_program_purpose": "Test",
"basic_academic_hours": "Test",
"basic_lessons": "Test",
"basic_hours_per_week": "Test",
"basic_attestation_hours": 100,
"basic_attestation_controls": "Test",
"basic_attestation_tools" :"Test",
"basic_attestation_evaluation": "Test",
"basic_attestation_scale": "Test",
"first_event_place": "Test",
"first_learning_outcomes": "Test",
"first_additional_information": "Test",
"first_program_purpose": "Test",
"first_academic_hours": "Test",
"first_lessons": "Test",
"first_hours_per_week": "Test",
"first_attestation_hours": 100,
"first_attestation_controls": "Test",
"first_attestation_tools" :"Test",
"first_attestation_evaluation": "Test",
"first_attestation_scale": "Test",
"advanced_event_place": "Test",
"advanced_learning_outcomes": "Test",
"advanced_additional_information": "Test",
"advanced_program_purpose": "Test",
"advanced_academic_hours": "Test",
"advanced_lessons": "Test",
"advanced_hours_per_week": "Test",
"advanced_attestation_hours": 100,
"advanced_attestation_controls": "Test",
"advanced_attestation_tools" :"Test",
"advanced_attestation_evaluation": "Test",
"advanced_attestation_scale": "Test",
"is_bas_project": true,
"bas_theory_academic_hours": 0,
"bas_practice_academic_hours": 0,
"bas_practice_format": "",
"bas_academic_hours_price": 0,
"bas_commerce_price": 0,
"bas_academic_hours_commerce_price": 0,
"bas_success_finished_users": 0,
"bas_confirmed_industry_order": false,
"bas_customer_company_name": null,
"bas_number_required_specialists": 0,
"bas_positions_required_specialists": "",
"bas_raex_rating": 0,
"bas_review_aeronext": "",
"bas_is_remote_data_transfer": false,
"bas_user_education": "",
"bas_no_entry_test": false,
"bas_all_regions": false,
"bas_fgos": "",
"bas_education_aims": "",
"bas_track_section": "",
"bas_tools_practice": "",
"bas_software_tools": "",
"bas_unique_skills": "",
"bas_commission_characteristics": "",
"bas_place_description": "",
"bas_media_practice_type": [
"Internship",
"Mentoring",
"Simulator",
"Competition",
"Other"
],
"bas_media_practice_format": "online",
"bas_media_practice_online_hours": 0,
"bas_media_practice_offline_hours": 0,
"bas_media_graduation_document": "Advanced training",
"bas_media_demand_reason": "test",
"bas_media_trajectory_fitting": "test",
"bas_media_result_skills": "test",
"bas_media_geography": "test",
"bas_media_practice_companies": "test",
"bas_media_learning_cases": "test",
"bas_media_attestation": "test",
"bas_sphere": "test",
"bas_track": "test",
"bas_program_type": null,
"regions": [ // Регионы
{
"name": "Москва",
"okato_code": "45000000000"
},
],
"kids_skills": "test",
"kids_tools": "test",
"kids_course_consist": "test",
"brief_description_platform": "test,
"block_one_name_key_feature": "test",
"block_two_name_key_feature": "test",
"block_three_name_key_feature": "test",
"kids_tools_technologies": "test",
"link_demo_course_one": "https://test.ru",
"link_demo_course_two": "https://test-two.ru",
"link_demo_course_three": "https://test-three.ru",
}
* 403 если не передан api key или он неверен
* 404 если курс не найден
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
v3 > course > enroll > list
Описание
Получение информации о заявке на курс проекта цифровые профессии 2021
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример get запроса
GET /api/v3/course/enroll/?platform_id=platform&unti_id=1&course_id=1
Параметры get запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - unti_id пользователя, обязательный параметр
* external_course_id - id курса, обязательный параметр
Пример ответа
* 200 {
"application_status": "approved", // статус заявки
"transfert_status": "activated", // статус трансферта
"flow_status": "" // статус потока
}
* 400 если переданы некорректные параметры
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс/заявка
v3 > course > enroll > create
Описание
Создание заявки на курс проекта цифровые профессии 2021
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример post запроса
POST /api/v3/course/enroll/{
"platform_id": "platform",
"unti_id": 1
"course_id": 1,
}
Параметры post запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - unti_id пользователя, обязательный параметр
* external_course_id - id курса, обязательный параметр
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры или нельзя изменить статус
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
v3 > course > enroll > update
Описание
Изменение статуса заявки на курс проекта цифровые профессии 2021
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Для разных статусов надо передавать разный набор параметров
Пример post запроса
PUT /api/v3/course/enroll/{
"platform_id": "platform",
"unti_id": 1
"course_id": 1,
"status": "declined"
}
Общие параметры put запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - unti_id пользователя, обязательный параметр
* course_id - id курса, обязательный параметр
* status - str, обязательный параметр. Возможные значения: approved (одобрена), declined (отклонена),
expelled (отчислен), accepted (зачислен)
Параметры для статуса approved
* flow - id потока, обязательный параметр
* enter_exam_date - дата в формате "%Y-%m-%d", обязательный параметр
Параметры для статуса expelled
* reason_choice - str, код причины отчисления, обязательный параметр Возможные варианты:
legitimate (Отчислен по уважительной причине),
not_legitimate (Отчислен по неуважительной причине)
* reason_file - файл с подтверждением причины отчисления
* reason_file_ds - файл с ЭЦП
Параметры для статуса accepted
* accept_date - дата в формате "%Y-%m-%d", дата зачисления слушателя, обязательный параметр
* admission_order_date - дата в формате "%Y-%m-%d", дата приказа о зачислении, обязательный параметр
* admission_order_number - str, номер приказа о зачислении, обязательный параметр
* employer_pays - true/false, за слушателя платит работодатель, если не передано, считается false
* employer_price - decimal c точностью до сотых, сумма оплаты Работодателем,
обязательно если employer_pays == true
* employer_ogrn - строка, содержащая только цифры, ОГРН/ОГРНИП Работодателя,
обязательно если employer_pays == true
* employer_name - строка, Наименование работодателя,
обязательно если employer_pays == true
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры или нельзя изменить статус
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс/заявка
v3 > ticket_application > list
Описание
Просмотр заявок на курсы.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
GET /api/v3/ticket_application/
Параметры запроса
Можно использовать следующие параметы для фильтрации списка (все параметры не обязательны):
* project_id - id проекта
* unti_id - unti_id пользователя
* course_id - id курса
* status - статус заявки, возможные значения: review, approved, approved_employer, accepted,
admitted, declined, expelled, not_admitted, finished
* status__in - статус заявки (множественный выбор), возможные значения: review, approved, approved_employer, accepted,
admitted, declined, expelled, not_admitted, finished через запятую без пробелов
* has_course_ref - пройдена ли рефлексия по курсу, о или 1
* has_modules_ref - пройдена рефлексия по всем модулям, 0 или 1
* reason_choice - причина отчисления, legitimate/not_legitimate
Пример ответа
{
"count": 1,
"next": null,
"previous": null,
"results": [...] // список объектов того же формата, как при запросе одной заявки
}
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
v3 > ticket_application > read
Описание
Просмотр конкретной заявки на на курс.
Запрос должен содержать хедер "Authorization: Token ***" с токеном пользователя с правами администратора
Пример запроса
GET /api/v3/ticket_application/1/
Пример ответа
{
"id": 1, // id заявки
"course_id": 1, // id курса
"user_id": 1, // id пользователя
"status": "accepted", // статус заявки
"reason_choice": "", // причина отклонения/отчисления
"applied_at": "2020-11-01T18:24:34.052473+03:00", // дата подачи заявки
"reviewed_at": "2020-11-15T20:20:16.941375+03:00", // дата последнего изменения статуса
"last_name": "Иванов",
"first_name": "Иван",
"second_name": "Иванович",
"user_email": "user0@mail.ru", // емейл пользвателя (данные leader-id)
"phone": [], // список телефонов
"unti_id": 1,
"leader_id": "1",
"esia_id": "1",
"project_id": 1,
"dt_finish": "2020-11-20T15:49:07.769205+03:00", // дата проставления отметки об окончании обучения
(если обучение окончено)
"finish_confirmed": null, // подтверждено успешное окончание обучения
"course_title": "Разработка веб-приложений",
"reviewer_last_name": "Автоматическя система",
"reviewer_first_name": "записи на курс",
"reviewer_second_name": "",
"has_course_ref": true, // оставена рефлекия по курсу
"has_modules_ref": true, // оставлена рефлексия по всем модулям курса
"snils": null,
"promocode": null,
"university_title": "университет",
"university_uuid": "8c45a560-2ad6-4c93-b777-f05ce8450f35", // UID образовательной организации
"digital_trace_submission_date": null, // Дата предоставления ЦС
"reflection_submission_date": null, // Дата проведения и предоставления Отчета об обучении (рефлексия)
"parent_ticketapplication_id": 2, // ID родительской заявки
"transfer_ticketapplication_id": 3, // ID родительской заявки при переводе с курса на курс
"wave_sign" : null, //
"flow": { // может быть null, если еще не выбран поток
"id": 18, // ID потока
"flow_num": 1, // номер потока в рамках курса
"date_start": "2021-10-09", // Дата начала обучения по потоку
"date_end": "2021-10-30", // Дата окончания обучения по потоку
"status": "ended" // статус потока (сформирован(filled)/закрыт(ended))
},
"future_code_module": { // может быть null, если курс не в 50 проекте
"id": 18, // ID модуля
"module_status": "active", // статус потока
"module_number": "1", // Порядковый номер потока
"course_id": 18, // ID курса
"flow_id": 18, // ID потока
},
"transfert": { // может быть null
"final_test_result": 1, // Результат итогового испытания (0 или 1)
"status": "closed", // Статус трансферта
"enter_exam_date": "2023-10-05T12:02:52+03:00", // Дата прохождения вступительных испытаний
"accept_date": "2021-10-07", // Дата зачисления
"admission_order_date": "2021-10-07", // Дата приказа о зачислении
"admission_order_number": "123123", // Номер приказа о зачислении
"employer_pays": false,
"employer_price": null, // float, Сумма, подлежащая оплате за счет средств Работодателя (будет не null, если employer_pays == true)
"employer_ogrn": "", // ОГРН /ОГРНИП Работодателя
"employer_name": "", // Наименование работодателя
"education_end_date": "2020-12-30", // Дата окончания обучения
"qualification_doc_number": "", // Номер бланка документа о квалификации
"qualification_doc_registration_number": "", // Регистрационный номер документа о квалификации
"frdo_number": "", // Номер ФРДО
"quailfication_doc_date": "2020-12-30", // Дата выдачи документа о квалификации
"expulsion_order_date": "2020-12-30", // Дата приказа об отчислении
"expulsion_order_number": "", // 'Номер приказа об отчислении
"final_exam_date": "2020-10-12", // Дата итогового испытания
"DT_answer1": null, // Наличие Отчета об обучении, bool если проставлено
"DT_answer2": null, // Состав Отчета об обучении, bool если проставлено
"DT_answer3": null, // Все ли ответы соответствуют требованиям к ответам, указанным в Приложении № 5 к Договору?, bool если проставлено
"Reflection": null, // Имеются ли обстоятельства, указанные в пункте 13 Приложения № 5 к Договору?, bool если проставлено
"report": null, // json с расширенной информацией о рефлексии
},
"documents": [ // список документов по потоку и заявке
{
"doc_uuid": "f0e54018-7630-4862-81ab-75dba3f67acd", // ЮИД документа (по заявке или по потоку)
"doc_type_uuid": "e4851231-2853-4060-9cfd-204006d6708b" // ЮИД типа документа (по заявке или по потоку)
}
]
}
* 401 если в запросе не содержится токен
* 403 если у пользователя не хватает прав
* 404 если заявка не найдена
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required |
v4 > course > enroll > create
Описание
Создание заявки на курс проекта цифровые профессии 2022
Запрос должен содержать хедер x-plp-api-key
Пример post запроса
POST /api/v4/course/enroll/{
"unti_id": 1
"course_id": 1,
}
Параметры post запроса
* unti_id - unti_id пользователя, обязательный параметр
* course_id - id курса, обязательный параметр
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры или заявка уже существует
* 403 если не передан api key или он некорректен
* 404 если не найден пользователь/курс
v5 > course > enroll > list
Описание
Получение статуса заявки на курс
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример get запроса
GET /api/v5/course/enroll/
Параметры get запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр, если не указан course_id
* course_id - индентификатор курса, обязательный параметр, если не указан external_course_id
Пример ответа
{
"application_id": 123,
"application_status": "review",
"transfert_status": "",
"admission_number": 1
"admission_order_date": "2022-11-11",
"expulsion_order_date": "2022-11-11",
"course_id": 1,
"future_code_module_id": 1,
"future_code_module_number": 1,
"flow_id": 1,
"pgu_id": 1,
"pgu_dt": "2022-11-11",
"additional_info": {},
"algorithm_grade": 123,
"language_grade": 123,
"motivation_grade": 123,
"applied_at": "2022-11-11",
"end_dt": "2022-11-11",
"untill_dt": "2022-11-11",
"difficulty_level": "intermediate"
"cof_exit_exam_status": "",
"exit_motivation_grade": 1,
"exit_algorithm_grade": 1,
"exit_language_grade": 1,
"is_timeout": true,
"exit_end_dt": "2022-11-11 12:00:00",
"certificate_url": "",
"certificate_number": ""
}
* 400 если не хватает параметров в запросе или они не верны
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
v5 > course > enroll > create
Описание
Создание заявки на курс
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример post запроса
POST /api/v5/course/enroll/
Параметры get запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр, если не указан course_id
* course_id - индентификатор курса, обязательный параметр, если не указан external_course_id
* project_id - id проекта, необязательный параметр, если курс участвует только в 1 проекте
* status - "review"/"accepted", необязательный параметр
Пример ответа
* {"success": true}
* 400 если не хватает параметров в запросе или они не верны
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
v5 > course > enroll > update
Описание
Изменение статуса заявки
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример put запроса
PUT /api/v5/course/enroll/
Параметры get запроса
* platform_id - индентификатор платформы, обязательный параметр
* unti_id - id пользователя, обязательный параметр
* external_course_id - индентификатор курса, обязательный параметр, если не указан course_id
* course_id - индентификатор курса, обязательный параметр, если не указан external_course_id
* status - новый статус, обязательный параметр
Пример ответа
* {"success": true}
* 400 если не хватает параметров в запросе или они не верны
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс
v6 > course > enroll > create
Описание
Создание заявки на курс проекта Дети 2022
Запрос должен содержать хедер x-plp-api-key
Пример post запроса
POST /api/v6/course/enroll/{
"unti_id": 1
"course_id": 1,
"pgu_id": 1,
"pgu_dt": "2022-11-11 12:00:00",
"additional_info": {},
"algorithm_grade": 123,
"language_grade": 123,
"motivation_grade": 123,
"end_dt": "2022-11-11 12:00:00",
"status": "accepted",
}
Параметры post запроса
* unti_id - unti_id пользователя, обязательный параметр
* course_id - id курса, обязательный параметр
* pgu_id - id заявки ПГУ
* pgu_dt - Дата заявки ПГУ
* additional_info = JSON дополнительная мета-информация о заявке
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры или заявка уже существует
* 403 если не передан api key или он некорректен
* 404 если не найден пользователь/курс
v6 > course > enroll > specify > create
Описание
Уточнение данных по реквизитам приказа на проекте КБ23-24
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Пример post запроса
POST /api/v6/course/enroll/specify/{
"application_id": 1,
"platform_id": "platform",
"accept_date": 2023-01-01,
"admission_order_date": 2023-01-01,
"admission_order_number": 1325345
}
Общие параметры post запроса (заявка должна быть в статусе accepted и должен быть хотя бы один параметр)
* application_id - индентификатор заявки, обязательный параметр
* platform_id - индентификатор платформы, обязательный параметр
* accept_date - дата в формате "%Y-%m-%d", дата зачисления слушателя, необязательный параметр
* admission_order_date - дата в формате "%Y-%m-%d", дата приказа о зачислении, необязательный параметр
* admission_order_number - str, номер приказа о зачислении, необязательный параметр
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс/заявка
v6 > course > enroll > update > create
Описание
Изменение статуса заявки на курс проекта проекта Дети 2022
Запрос должен содержать хедер "Authorization: Token ***" с токеном администратора платформы
Для разных статусов надо передавать разный набор параметров
Пример post запроса
POST /api/v6/course/enroll/update/{
"platform_id": "platform",
"application_id": 1,
"unti_id": 1
"course_id": 1,
"status": "declined",
"difficulty_level" : "elementary"
}
Общие параметры post запроса
* platform_id - индентификатор платформы, обязательный параметр
* application_id - индентификатор заявки, обязательный параметр, если не указаны unti_id, course_id
* unti_id - unti_id пользователя, обязательный параметр, если не указан applicaion_id
* course_id - id курса, обязательный параметр, если не указан applicaion_id
* status - str, обязательный параметр. Возможные значения: approved (одобрена), declined (отклонена),
expelled (отчислен), accepted (зачислен), finished (завершена)
Параметры для статуса approved
* flow - id потока, обязательный параметр
* enter_exam_date - дата в формате "%Y-%m-%d", обязательный параметр
Параметры для статуса declined
* reason_choice - str, код причины отчисления, обязательный параметр Возможные варианты:
application_deadline (Получатель услуги не воспользовался возможностью прохождения Вступительного испытания (истечение срока заявки)),
enter_exam_fail (Вступительные испытания пройдены неуспешно),
by_recipient (Отклонено в связи с обращением заявителя/получателя поддержки),
not_support_recipient (Заявитель не является получателем поддержки),
no_places (Отсутствие свободного места на площадке Провайдера),
provider_transfer (Перевод от Провайдера),
other (Иное),
Параметры для статуса expelled
* reason_choice - str, код причины отчисления, обязательный параметр Возможные варианты:
reason_expelled_legitimate_user_application (По желанию заявителя)
reason_expelled_legitimate_blocked (В связи с блоком на ЕПГУ)
reason_expelled_legitimate_illness (Заболевание, амбулаторное, стационарное, санаторное лечение)
reason_expelled_legitimate_accomodation (Изменение места жительства)
reason_expelled_legitimate_family (Особые семейные обстоятельства)
reason_expelled_legitimate_war (Особые условия нахождения Получателя услуги)
reason_expelled_legitimate_army (Невозможность завершения обучения)
reason_expelled_legitimate_provider_error (Ошибочно зачислен Провайдером)
reason_expelled_legitimate_other (Другое - уважительная)
reason_expelled_not_legitimate_absence (Непосещаемость)
reason_expelled_not_legitimate_exam_failed (Неуспешная сдача промежуточной аттестации)
reason_expelled_not_legitimate_no_document (Отсутствие справки)
reason_expelled_not_legitimate_no_contract (Незаключение договора)
reason_expelled_not_legitimate_other (Другое - неуважительная)
* reason_file - файл с подтверждением причины отчисления
* reason_file_ds - файл с ЭЦП
Параметры для статуса accepted
* accept_date - дата в формате "%Y-%m-%d", дата зачисления слушателя, обязательный параметр
* admission_order_date - дата в формате "%Y-%m-%d", дата приказа о зачислении, обязательный параметр
* admission_order_number - str, номер приказа о зачислении, обязательный параметр
* employer_pays - true/false, за слушателя платит работодатель, если не передано, считается false
* employer_price - decimal c точностью до сотых, сумма оплаты Работодателем,
обязательно если employer_pays == true
* employer_ogrn - строка, содержащая только цифры, ОГРН/ОГРНИП Работодателя,
обязательно если employer_pays == true
* employer_name - строка, Наименование работодателя,
обязательно если employer_pays == true
* difficulty_level - str, возможные значения: intermediate, elementary, advanced
В случае если надо поменять уровень сложности, анкета должна быть в статусе accepted
* platform_id - индентификатор платформы, обязательный параметр
* application_id - индентификатор заявки
* difficulty_level - str, возможные значения: intermediate, elementary, advanced
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры или нельзя изменить статус
* 401 если запрос не авторизован
* 403 если пользователь не является администратором указанной платформы
* 404 если не найден пользователь/курс/заявка
v7 > course > enroll > create
Описание
Создание заявки на курс проекта БАС
Запрос должен содержать хедер x-plp-api-key
Пример post запроса
POST /api/v7/course/enroll/{
"unti_id": 1
"course_id": 1,
}
Параметры post запроса
* unti_id - unti_id пользователя, обязательный параметр
* course_id - id курса, обязательный параметр
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры или заявка уже существует
* 403 если не передан api key или он некорректен
* 404 если не найден пользователь/курс
v8 > course > enroll > create
Описание
Создание заявки на курс проекта БАС бесплатный (без трансферта и потоков)
Запрос должен содержать хедер x-plp-api-key
Пример post запроса
POST /api/v8/course/enroll/{
"unti_id": 1
"course_id": 1,
}
Параметры post запроса
* unti_id - unti_id пользователя, обязательный параметр
* course_id - id курса, обязательный параметр
Пример ответа
* 200 {"success": true}
* 400 если переданы некорректные параметры или заявка уже существует
* 403 если не передан api key или он некорректен
* 404 если не найден пользователь/курс
catalog_api
v1 > course_stats > create
Метод для сохранения результатов прохождения курса пользователями из LMS.
Для вызова данного метода необходимо добавить в headers - Authorization: Token (токен, который выдается для организации)
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
platform_id required | |
account_id required | |
unti_id required | |
event_type | |
external_course_id required | |
score | |
success | |
time_spent | |
started_at required | |
finished_at required |
v1 > course_user_requests > cancel-request > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
confirm required |
v1 > course_user_requests > create-request > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
project_id required | |
pgu_id |
v1 > courses > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
title | |
course_format | |
organization_id | |
project_id | |
search | A search term. |
v1 > courses > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
organization_id required | |
annotation required | |
description | Максимальная длина поля - 50000 символов |
external_url required | |
planned_results required | |
additional_info | Дополнительные разделы в описании курса. Обязательно указывать id у h2 тегов, чтобы к ним можно было перепрыгнуть. Максимальная длина поля - 50000 символов |
price | |
programming_language_id required | |
specifications | Максимальная длина поля - 50000 символов |
extended_params required |
v1 > courses > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Курс. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
title | |
course_format | |
organization_id | |
project_id | |
search | A search term. |
v1 > courses > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Курс. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
title | |
course_format | |
organization_id | |
project_id | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
organization_id | |
annotation | |
description | Максимальная длина поля - 50000 символов |
external_url | |
planned_results | |
additional_info | Дополнительные разделы в описании курса. Обязательно указывать id у h2 тегов, чтобы к ним можно было перепрыгнуть. Максимальная длина поля - 50000 символов |
price | |
programming_language_id | |
specifications | Максимальная длина поля - 50000 символов |
extended_params |
v1 > courses > update_course_cover
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Курс. |
Request Body
The request body should be a "multipart/form-data"
encoded object, containing the following items.
Parameter | Description |
---|---|
cover |
v1 > courses > register_user_in_course
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Курс. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
user_id required | |
project_id required |
v1 > courses > competences > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
v1 > courses > competences > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | Не менее 10 символов |
competence_type required | |
knowledge | Не менее 30 символов |
skills | Не менее 30 символов |
tools | Не менее 30 символов |
v1 > courses > competences > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Компетенция курса. |
v1 > courses > competences > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Компетенция курса. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | Не менее 10 символов |
competence_type | |
knowledge | Не менее 30 символов |
skills | Не менее 30 символов |
tools | Не менее 30 символов |
v1 > courses > competences > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Компетенция курса. |
v1 > courses > development_scenarios > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
v1 > courses > development_scenarios > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
unemployed_registered_employed | |
unemployed_registered_freelance | |
unemployed_registered_business_owner | |
unemployed_employed | |
unemployed_freelance | |
unemployed_business_owner | |
employed_job_preservation | |
employed_max_efficiency | |
employed_max_salary | |
employed_new_position | |
employed_additional_income | |
employed_maintain_qualifications | |
freelance_maintain_qualifications | |
freelance_max_salary | |
freelance_business_expansion | |
employed_same_business | |
employed_new_business | |
employed_employed | |
freelance_same_employment | |
freelance_new_employment |
v1 > courses > module > edu_resources > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
v1 > courses > module > edu_resources > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
contents required | Не менее 10 символов, если значение добавлено |
v1 > courses > module > edu_resources > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Электронный образовательный ресурс. |
v1 > courses > module > edu_resources > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Электронный образовательный ресурс. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
contents | Не менее 10 символов, если значение добавлено |
v1 > courses > module > edu_resources > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Электронный образовательный ресурс. |
v1 > courses > module > info_resources > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
v1 > courses > module > info_resources > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
contents required | Не менее 10 символов, если значение добавлено |
v1 > courses > module > info_resources > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Электронный информационный ресурс. |
v1 > courses > module > info_resources > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Электронный информационный ресурс. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
contents | Не менее 10 символов, если значение добавлено |
v1 > courses > module > info_resources > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Электронный информационный ресурс. |
v1 > courses > module > materials > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
v1 > courses > module > materials > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
technologies required | Не менее 10 символов |
methodical_developments required | Не менее 10 символов |
module_materials required | |
literature required | Не менее 10 символов |
v1 > courses > module > materials > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Учебно-методический материал. |
v1 > courses > module > materials > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Учебно-методический материал. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
technologies | Не менее 10 символов |
methodical_developments | Не менее 10 символов |
module_materials | |
literature | Не менее 10 символов |
v1 > courses > module > materials > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Учебно-методический материал. |
v1 > courses > module > program_terms > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
v1 > courses > module > program_terms > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type_of_occupation required | От 5 до 50 символов |
equipment required | Не менее 2 символов |
software required | Не менее 2 символов |
v1 > courses > module > program_terms > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Материально-технические условие реализации программы. |
v1 > courses > module > program_terms > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Материально-технические условие реализации программы. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
type_of_occupation | От 5 до 50 символов |
equipment | Не менее 2 символов |
software | Не менее 2 символов |
v1 > courses > module > program_terms > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Материально-технические условие реализации программы. |
v1 > courses > module > themes > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
v1 > courses > module > themes > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | От 4 до 255 символов |
lectures_hours | Минимум одно из трёх значений (лекции, практические занятия, самостоятельная работа) должно быть ненулевым |
lectures_content | Не менее 50 символов при ненулевом количестве академических часов лекций |
workshops_hours | Минимум одно из трёх значений (лекции, практические занятия, самостоятельная работа) должно быть ненулевым |
workshops_content | Не менее 100 символов при ненулевом количестве академических часов практических занятий |
independent_work_hours | Минимум одно из трёх значений (лекции, практические занятия, самостоятельная работа) должно быть ненулевым |
independent_work_content | Не менее 50 символов при ненулевом количестве академических часов самостоятельной работы |
v1 > courses > module > themes > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Тема. |
v1 > courses > module > themes > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Тема. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | От 4 до 255 символов |
lectures_hours | Минимум одно из трёх значений (лекции, практические занятия, самостоятельная работа) должно быть ненулевым |
lectures_content | Не менее 50 символов при ненулевом количестве академических часов лекций |
workshops_hours | Минимум одно из трёх значений (лекции, практические занятия, самостоятельная работа) должно быть ненулевым |
workshops_content | Не менее 100 символов при ненулевом количестве академических часов практических занятий |
independent_work_hours | Минимум одно из трёх значений (лекции, практические занятия, самостоятельная работа) должно быть ненулевым |
independent_work_content | Не менее 50 символов при ненулевом количестве академических часов самостоятельной работы |
v1 > courses > module > themes > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
module_id required | |
id required | A unique integer value identifying this Тема. |
v1 > courses > modules > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
v1 > courses > modules > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | От 4 символов |
description required | |
is_hidden | |
position required | |
competences | |
attestation_hours | |
attestation_controls | |
attestation_tools | |
attestation_evaluation | |
attestation_scale |
v1 > courses > modules > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Модуль курса. |
v1 > courses > modules > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Модуль курса. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | От 4 символов |
description | |
is_hidden | |
position | |
competences | |
attestation_hours | |
attestation_controls | |
attestation_tools | |
attestation_evaluation | |
attestation_scale |
v1 > courses > modules > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Модуль курса. |
v1 > courses > modules > get_course_module_summary
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Модуль курса. |
v1 > courses > requests > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
status | |
course_id | |
organization_id | |
project_id | |
user_id |
v1 > courses > requests > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this ticket application. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
status | |
course_id | |
organization_id | |
project_id | |
user_id |
v1 > courses > requests > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this ticket application. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
status | |
course_id | |
organization_id | |
project_id | |
user_id |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
status |
v1 > courses > sessions > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
v1 > courses > sessions > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
session_number required | |
date_started required | |
date_ended required |
v1 > courses > sessions > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Поток обучения. |
v1 > courses > sessions > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Поток обучения. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
session_number | |
date_started | |
date_ended |
v1 > courses > sessions > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required | |
id required | A unique integer value identifying this Поток обучения. |
v1 > courses > teachers > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
v1 > courses > teachers > update_course_teachers
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
course_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
teachers_ids |
v1 > documents > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
organization_id |
v1 > documents > create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
doc_uuid | |
doc_type_id required | |
organization_id required | |
comment | |
creator_id required | |
created_at | |
is_inbox |
v1 > documents > download > document_file_download_url
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization_id required | |
file_uuid required | |
doc_uuid required | |
file_type |
v1 > documents > upload > document_file_upload_url
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization_id required | |
file_name required | |
file_type | |
doc_uuid required |
v1 > internal > logout
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
unti_id required |
v1 > internal > token
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
unti_id required |
v1 > main > courses > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
title | |
course_format | |
organization_id | |
project_id | |
category_id | |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > main > courses > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Курс. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
title | |
course_format | |
organization_id | |
project_id | |
category_id | |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > main > courses > get_course_summary
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Курс. |
v1 > organizations > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
user_id | |
search | A search term. |
v1 > organizations > create
Request Body
The request body should be a "multipart/form-data"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
description required | |
logo | |
contact_person required | |
email required | |
phone required | |
site |
v1 > organizations > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Университет. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_id | |
search | A search term. |
v1 > organizations > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Университет. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
user_id | |
search | A search term. |
Request Body
The request body should be a "multipart/form-data"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
description | |
logo | |
contact_person | |
email | |
phone | |
site |
v1 > organizations > legal_entity > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Университет. |
v1 > organizations > legal_entity > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Университет. |
Request Body
The request body should be a "multipart/form-data"
encoded object, containing the following items.
Parameter | Description |
---|---|
is_entrepreneur | |
inn | 10 цифр |
kpp | 9 цифр |
ogrn | 13 цифр |
checking_account | |
correspondent_account | |
personal_account | |
bank_bik | 9 цифр |
bank_name | |
signer_fullname | |
signer_grounds | |
signer_post | |
legal_address | |
legal_name | |
license_number | |
license_date | |
license_file | Файл формата pdf или jpg. Максимальный размер - 10Мб |
no_debts_confirmation | Файл формата pdf или jpg. Максимальный размер - 10Мб |
apkit_confirmation | Файл формата pdf или jpg. Максимальный размер - 10Мб |
software_confirmation | Файл формата pdf или jpg. Максимальный размер - 10Мб |
authority_confirmation | Если подтверждается двумя документами, то они прикладываются одним файлом. Файл формата pdf или jpg. Максимальный размер - 10Мб |
has_signature |
v1 > programming_languages > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Язык программирования. |
v1 > projects > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
title | |
organization_id |
v1 > projects > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Проект. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
title | |
organization_id |
v1 > teachers > list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
page | A page number within the paginated result set. |
per_page | Number of results to return per page. |
organization_id | |
search | A search term. |
v1 > teachers > create
Request Body
The request body should be a "multipart/form-data"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization_id required | |
last_name required | |
first_name required | |
second_name | |
is_main_workplace_matches required | |
main_workspace | |
post required | |
is_academic_degree required | |
academic_degree | |
is_academic_status required | |
academic_status | |
is_portfolio_links required | |
portfolio_links | |
photo |
v1 > teachers > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Преподаватель. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
organization_id | |
search | A search term. |
v1 > teachers > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Преподаватель. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
organization_id | |
search | A search term. |
Request Body
The request body should be a "multipart/form-data"
encoded object, containing the following items.
Parameter | Description |
---|---|
organization_id | |
last_name | |
first_name | |
second_name | |
is_main_workplace_matches | |
main_workspace | |
post | |
is_academic_degree | |
academic_degree | |
is_academic_status | |
academic_status | |
is_portfolio_links | |
portfolio_links | |
photo |
v1 > users > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Сценарий развития слушаталей. |
v1 > users > get_profile_organization
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Сценарий развития слушаталей. |
organization_id required |
v1 > users > get_profile
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this Сценарий развития слушаталей. |
coursera
steps-subscriptions > list
Описание
API информации о лимитах авторов подборок
Запрос должен содержать хедер x-plp-api-key
Пример запроса
GET /coursera/steps-subscriptions/
GET /coursera/steps-subscriptions/?author_unti_id=xxx
Параметры get запроса * author_unti_id - uuid автора коллекции, опциональный параметр. Если для автора ранее не выдан лимит, он будет выдан автоматически * user_unti_id - unti ID пользователя для проверки - может ли он быть записан на курс из подборки автора или нет, опциональный параметр
Пример ответа
* 200 { ... "data": [{"author_unti_id": "...", "limit": 100, "is_active": true, "can_enroll": true, "students_num": 2}, ... ] ... }
* 403 если не передан api key