childrens

Login

POST /login

Logout

POST /logout

POST /login

Request body

Object

login

string

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

pass

string

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

Responses

201 Created

Body

Object

token

string

Токен авторизации

POST /logout

Responses

201 Created

Profile

GET /profile/{id}

Profile

DELETE /profile/{id}

GET /profile/{id}

Path variables

id

string required

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

Responses

200 OK

Body

ProfileModel

Examples

{
    "id": "",
    "name": "",
    "email": "",
    "pass": "",
    "birthday": "",
    "phone": ""
}

DELETE /profile/{id}

Path variables

id

string required

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

Responses

204 No Content

About

GET /about

About

PATCH /about

GET /about

Responses

200 OK

Body

AboutModel

Example:

{
    "description": "",
    "phone": "",
    "email": "",
    "slides": [
        ""
    ]
}

PATCH /about

Request body

AboutModel

Examples

{
    "description": "",
    "phone": "",
    "email": "",
    "slides": [
        ""
    ]
}

Responses

200 OK

Specialities

GET /specialities

Specialities

POST /specialities

Specialities

DELETE /specialities/{id}

GET /specialities

Responses

200 OK

Body

Array of SpecialityModel

Examples

[
    {
        "id": "",
        "teacherId": "",
        "name": "",
        "topic": "",
        "description": "",
        "image": ""
    }
]

POST /specialities

Request body

SpecialityModel (New)

Examples

{
    "name": "",
    "teacherId": "",
    "topic": "",
    "description": "",
    "image": ""
}

Responses

201 Created

DELETE /specialities/{id}

Path variables

id

string required

id направления

Responses

204 No Content

Body

boolean

Students

GET /students

Students

POST /register/student

Students

PATCH /students/{id}

Students specialities

GET /students/{id}/specialities

Students specialities

PATCH /students/{id}/specialites

Students tests

GET /students/{id}/tests

Students pass test

PATCH /students/{id}/tests

GET /students

Responses

200 OK

Body

Array of StudentModel (Child/Parent)

Examples

[
    {
        "id": "",
        "name": "",
        "email": "",
        "pass": "",
        "birthday": "",
        "image": ""
    }
]

POST /register/student

Request body

StudentModel (New Child/Parent)

Examples

{
    "name": "",
    "email": "",
    "pass": "",
    "birthday": "",
    "image": ""
}

Responses

201 Created

PATCH /students/{id}

Path variables

id

string required

id ученика

Request body

StudentModel (New Child/Parent)

Examples

{
    "name": "",
    "email": "",
    "pass": "",
    "birthday": "",
    "image": ""
}

Responses

201 Created

GET /students/{id}/specialities

Path variables

id

string required

id ученика

Responses

200 OK

Body

string

PATCH /students/{id}/specialites

Path variables

id

string required

id ученика

Request body

Object

specialityId

string

id направления

Responses

200 OK

GET /students/{id}/tests

Path variables

id

string required

id ученика

Responses

200 OK

Body

Object

score

string

Общее количество баллов

tests

Array

Выполненные задания

Object

title

string

Название теста

score

string

Количество баллов

PATCH /students/{id}/tests

Path variables

id

string required

Request body

Object

testId

string

id теста

tasks

Array

Список задач

Object

questionId

string

id вопроса

answer

string

Ответ на вопрос

Enumeration:

Если тип вопроса "checkbox", то придет массив id

Если тип вопроса "radio", то придет id

Если тип вопроса "input", то придет строка с ответом

Responses

201 Created

Body

Object

score

string

Количество баллов за тест

test

TestModel (Teacher)

Тест с ответами

Examples

{
    "score": "",
    "test": {
        "id": "",
        "specialityId": "",
        "title": "",
        "maxScore": 1,
        "description": "",
        "tasks": [
            {
                "id": "",
                "type": "input",
                "question": "",
                "variants": [
                    {
                        "id": "",
                        "answer": ""
                    }
                ],
                "answers": "строка ответа"
            }
        ]
    }
}

Schedules

GET /schedules

Schedules

POST /schedules

Schedules

DELETE /schedules

GET /schedules

Request parameters

specialityId

string required

id направления

from

string optional

Дата начала расписания

to

string optional

Дата окончания расписания

Responses

200 OK

Body

Array of ScheduleDayModel

Examples

[
    {
        "date": "",
        "specialityId": "",
        "lessons": [
            {
                "id": "",
                "taskId": "",
                "date": "",
                "from": "",
                "to": "",
                "title": "",
                "groupSize": "",
                "subscribedNum": ""
            }
        ]
    }
]

POST /schedules

Request body

ScheduleDayModel (New)

Examples

{
    "date": "",
    "specialityId": "",
    "lessons": [
        {
            "taskId": "",
            "date": "",
            "from": "",
            "to": "",
            "title": "",
            "groupSize": ""
        }
    ]
}

Responses

201 Created

DELETE /schedules

Request parameters

specialityId

string optional

id направления

Responses

204 No Content

Teachers

GET /teachers

Teachers

POST /teachers

GET /teachers

Responses

200 OK

Body

Array of TeacherModel

Examples

[
    {
        "id": "",
        "fullname": "",
        "email": "",
        "pass": "",
        "birthday": "",
        "phone": "",
        "specialityId": "",
        "description": "",
        "image": ""
    }
]

POST /teachers

Request body

TeacherModel (New)

Examples

{
    "fullname": "",
    "email": "",
    "pass": "",
    "birthday": "",
    "phone": "",
    "specialityId": "",
    "description": "",
    "image": ""
}

Responses

201 Created

Tests

GET /tests

Tests

GET /tests/{id}

Tests

POST /tests

GET /tests

Request parameters

specialityId

string optional

id направления

search

string optional

Поиск по названию направления

Responses

200 OK

Body

Array of TestModel (Teacher)

Examples

[
    {
        "id": "",
        "specialityId": "",
        "title": "",
        "maxScore": 1,
        "description": "",
        "tasks": [
            {
                "id": "",
                "type": "radio",
                "question": "",
                "variants": [
                    {
                        "id": "",
                        "answer": ""
                    }
                ],
                "answers": "id"
            }
        ]
    }
]

GET /tests/{id}

Path variables

id

string required

id теста

Responses

200 OK

Body

TestModel (Student)

Examples

{
    "id": "",
    "specialityId": "",
    "title": "",
    "maxScore": 1,
    "description": "",
    "tasks": [
        {
            "id": "",
            "type": "radio",
            "question": "",
            "variants": [
                {
                    "id": "",
                    "answer": ""
                }
            ]
        }
    ]
}

POST /tests

Request body

TestModel (New)

Examples

{
    "specialityId": "",
    "title": "",
    "maxScore": 1,
    "description": "",
    "tasks": [
        {
            "type": "checkbox",
            "question": "",
            "variants": [
                {
                    "id": "",
                    "answer": ""
                }
            ],
            "answers": "строка ответа"
        }
    ]
}

Responses

201 Created

Object

description

string

Основной блок текста

phone

string

Контактный телефон

email

string

Электронная почта

slides

Array of string

Список картинок для слайдера на главной странице

Object

id

string

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

name

string

ФИО

email

string

Электронная почта пользователя

pass

string

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

birthday

string

День рождения пользователя

phone

string

Мобильный телефон пользователя

Object

id

string

id направления

teacherId

string

id учителя

name

string

Наименование направления

topic

string

Краткое описание направления

description

string

Описание направления

image

string

Изображение направления (строка)

Object

name

string

Наименование направления

teacherId

string

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

topic

string

Краткое описание направления

description

string

Описание направления

image

string

Изображение направления (файл)

Object

name

string

ФИО

email

string

Электронная почта пользователя

pass

string

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

birthday

string

День рождения пользователя

image

string

Изображение пользователя (файл)

Object

id

string

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

name

string

ФИО

email

string

Электронная почта пользователя

pass

string

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

birthday

string

День рождения пользователя

image

string

Изображение пользователя (строка)

Object

taskId

string

id задачи

date

string

Дата занятия

from

string

Время начала занятия

to

string

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

title

string

Тема занятия

groupSize

string

Максимально допустимый размер группы

Object

id

string

id занятия

taskId

string

id задачи

date

string

Дата занятия

from

string

Время начала занятия

to

string

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

title

string

Тема занятия

groupSize

string

Максимально допустимый размер группы

subscribedNum

string

Количество учеников, записавшихся на занятие

Object

date

string

Дата дня расписания

specialityId

string

id направления

lessons

Array of LessonModel

занятия за день

Object

date

string

Дата дня расписания

specialityId

string

id направления

lessons

Array of LessonModel (New)

занятия за день

Object

fullname

string

ФИО

email

string

Электронная почта пользователя

pass

string

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

birthday

string

День рождения пользователя

phone

string

Мобильный телефон пользователя

specialityId

string

id специальности учителя

description

string

Описание учителя

image

string

Изображение учителя (файл)

Object

id

string

id учителя

fullname

string

ФИО

email

string

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

pass

string

Пароль учителя

birthday

string

День рождения учителя

phone

string

Мобильный телефон учителя

specialityId

string

id специальности учителя

description

string

Описание учителя

image

string

Изображение учителя (строка)

Object

type

string

Enumeration:

checkbox

Задание с выбором нескольких отвеетов

radio

Задание с выбором одного ответа

input

Задание с письменным ответом

question

string

Текст вопроса

variants

Array of AnswerModel

Массив вариантов ответа

answers

Ответ на вопрос

Object

id

string

id задания

type

string

Enumeration:

checkbox

Задание с выбором нескольких отвеетов

radio

Задание с выбором одного ответа

input

Задание с письменным ответом

question

string

Текст вопроса

variants

Array of AnswerModel

Массив вариантов ответа

answers

Ответ на вопрос

Object

id

string

id вопроса

type

string

Enumeration:

checkbox

Задание с выбором нескольких отвеетов

radio

Задание с выбором одного ответа

input

Задание с письменным ответом

question

string

Текст вопроса

variants

Array of AnswerModel

Массив ответов на вопрос

Object

id

string

id вопроса

answer

string

Текст ответа

Object

specialityId

string

id направления

title

string

Название теста

maxScore

number

Количество баллов за теста

description

string

Описание теста

tasks

Array of TaskModel (New)

Массив заданий

Object

id

string

id теста

specialityId

string

id направления

title

string

Название теста

maxScore

number

Количество баллов за теста

description

string

Описание теста

tasks

Array of TaskModel (Teacher)

Массив заданий

Object

id

string

id теста

specialityId

string

id направления

title

string

Название теста

maxScore

number

Количество баллов за теста

description

string

Описание теста

tasks

Array of TaskModel

Массив заданий

string

Enumeration:

массив id

id

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