Epos Next (1.0.0)

Download OpenAPI specification:Download

E-mail: m@zotov.dev URL: https://zotov.dev License: MIT Licence

Authentication

JWT

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Data

Получение всех необходимых данных

Authorizations:

JWT (User)

Responses

Response samples

200
403
404
500

Content type

application/json

{"success": true,
"data": {"user": {"id": 63,
"name": "Ярослав Зотов"
},
"lessons": [{"id": 63,
"subject": "Физика",
"groupId": 10,
"room": "201",
"lessonNumber": 1,
"duration": 45,
"date": "2021-05-31T09:55:00.000"
},
{"id": 63,
"subject": "Физика",
"groupId": 10,
"room": "203",
"lessonNumber": 2,
"duration": 45,
"date": "2021-05-31T09:55:00.000"
},
{"id": 64,
"subject": "Геометрия",
"groupId": 11,
"room": "204",
"lessonNumber": 3,
"duration": 45,
"date": "2021-05-31T09:55:00.000"
},
{"id": 65,
"subject": "Химия",
"groupId": 12,
"room": "303",
"lessonNumber": 4,
"duration": 45,
"date": "2021-05-31T09:55:00.000"
},
{"id": 66,
"subject": "Английский язык",
"groupId": 13,
"room": "209",
"lessonNumber": 5,
"date": "2021-05-31T09:55:00.000"
},
{"id": 67,
"subject": "География",
"groupId": 14,
"room": "308",
"lessonNumber": 1
}
],
"homework": [{"id": 0,
"lesson": "Физика",
"content": "параграф 63",
"done": true
}
],
"controlWorks": [{"id": 63,
"lesson": "Алгебра",
"date": "2021-05-29",
"name": "Степени с целым показателем"
}
],
"advertisements": [{"id": 63,
"content": "Не забудьте взять листочки!!!",
"targetDate": "2021-05-29"
}
],
"marks": [{"Алгебра": {"periods": [{"all": [{"value": 5,
"date": "2021-01-16T00:00:00",
"topic": "Преобразование выражений, содержащих квадратные корни",
"name": "Контрольная работа по теме"
},
{"value": 4,
"date": "2021-01-25T00:00:00",
"topic": "Неполные квадратные уравнения",
"name": "Проверка домашнего задания"
},
{"value": 5,
"date": "2021-01-27T00:00:00",
"topic": "Неполные квадратные уравнения",
"name": "Проверка домашнего задания"
}
],
"total": 4
}
],
"total": 4
},
"Физика": {"periods": [{"all": [{"value": 4,
"date": "2020-09-01T00:00:00",
"topic": "Механическая энергия",
"name": "Решение задач по теме"
},
{"value": 4,
"date": "2020-09-01T00:00:00",
"topic": "Механическая энергия",
"name": "Решение задач по теме"
},
{"value": 4,
"date": "2020-09-15T00:00:00",
"topic": "Механическая энергия",
"name": "Промежуточная аттестация предудущего периода"
}
],
"total": 4
}
],
"total": 4
}
}
]
}
}

Получение списка уроков

Authorizations:

JWT (User)

query Parameters

from required	string Дата в ISO формате с которой нужно получить уроки (включительно)
to required	string Дата в ISO формате до которой нужно получить уроки (включительно)

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"success": true,
"data": [{"id": 63,
"subject": "Физика",
"groupId": 10,
"room": "201",
"lessonNumber": 1,
"date": "2021-05-31T09:55:00.000",
"duration": 45
}
]
}

Создать контрольную работу

Authorizations:

JWT (User)

Request Body schema: application/json

lesson	string [ 0 .. 256 ] characters Урок, на котором будет эта КР
date	string Когда будет эта КР. Дата в ISO формате
name	string [ 0 .. 256 ] characters Название этой КР

Responses

Request samples

Payload

Content type

application/json

{"lesson": "Физика",
"date": "2021-05-03T07:45:30.228Z",
"name": "Работа по электростатике"
}

Response samples

200
400
403

Content type

application/json

{"success": true,
"id": 1
}

Создать объявление

Authorizations:

JWT (User)

Request Body schema: application/json

content	string [ 0 .. 2056 ] characters Содержание объявления
targetDate	string Дата, до которой это объявление будет актуально. ISO формат

Responses

Request samples

Payload

Content type

application/json

{"content": "Физика",
"targetDate": "2021-05-03T07:45:30.228Z"
}

Response samples

200
400
403

Content type

application/json

{"success": true,
"id": 1
}

Auth

Авторизация пользователей

Request Body schema: application/json

email	string [ 1 .. 255 ] characters Email пользователя
password	string [ 1 .. 255 ] characters Пароль пользователя

Responses

Request samples

Payload

Content type

application/json

{"email": "sanya2005@gmail.com",
"password": "12345678a"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"tokens": {"auth": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ",
"refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ"
},
"id": 0
}

Обновление JWT токенов

Request Body schema: application/json

id	integer >= 0 ID пользователя
refresh	string (token) /^[A-Za-z0-9-_=]+\.[A-Za-z0-9-_=]+\.?[A-Za-z0...

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ"
}

Response samples

200
400
500

Content type

application/json

{"success": true,
"tokens": {"auth": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ",
"refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ"
},
"id": 0
}