FTE service
by kh-karina

FTE service

Сервис для учета трудозатрат сотрудников
Authentification
Проверить авторизацию пользователя
POST /fte_records/signin/auth_check
Авторизировать пользователя
POST /fte_records/signin
Зарегестрировать нового пользователя
POST /fte_records/register
Проверить авторизацию пользователя
POST /fte_records/signin/auth_check

Authentication

bearerAuth

Проверка валидности токена авторизации

Responses

200 200

Токен валиден

Body
application/json
Object
message
string
Example:
Пользователь авторизован.
401 401

Ошибка авторизации

Body
application/json
One of
Object
error
string
Example:
Отсутствует токен.
Object
error
string
Example:
Срок действия токена истек. Авторизуйтесь заново.
404 404

Авторизация не найдена

Body
application/json
Object
error
string
Example:
Авторизация не найдена в системе.
Авторизировать пользователя
POST /fte_records/signin

Аутентификация пользователя и получение токена сессии

Request body

application/json
Object
email_input
string email required

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

Example:
user@mail.ru
pwd_input
string required

Пароль (минимум 8 символов)

Min length: 8
Example:
hfy745Ykfd

Responses

200 200

Успешная авторизация

Body
application/json
Object
message
string
Example:
Вы успешно авторизованы.
user_email_auth
string
Example:
user@mail.ru
system_role
string
Enumeration:
manager
employee
Example:
manager
token_session
string
Example:
I1fS_KwTFyytMcjz_YbpvCv__22s_puXuzmA-jhdHW8
400 400

Невалидные входные данные

Body
application/json
One of
Object
error
string
Example:
Тело запроса не может быть пустым
Object
error
string
Example:
Отсутствуют обязательные поля
missing_fields
Array of string
Object
error
string
Example:
Обязательные поля не могут быть пустыми
empty_fields
Array of string
Object
error
string
Example:
Некорректный формат email
message
string
Example:
Проверьте введенный email. Должен соответствовать виду: user@example.com
Object
error
string
Example:
Слишком короткий пароль
message
string
Example:
Проверьте введенный пароль. Пароль должен содержать минимум 8 символов
401 401

Неверный пароль

Body
application/json
Object
error
string
Example:
Неверный пароль для указанного email.
404 404

Пользователь не найден

Body
application/json
Object
error
string
Example:
В системе нет зарегистрированного аккаунта с введенным email.
500 500

Ошибка сервера

Body
application/json
Object
error
string
Example:
Ошибка сервера. Попробуйте повторить позже
Example 1
POST https://web-production-a0b7.up.railway.app/fte_records/signin HTTP/1.1 

Content-Type: application/json

{
    "email_input": "user@mail.ru",
    "pwd_input": "hfy745Ykfd"
}
Зарегестрировать нового пользователя
POST /fte_records/register

Создание новой учетной записи пользователя в системе

Request body

application/json
Object
email_input
string email required

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

Example:
user@mail.ru
pwd_input
string required

Пароль (минимум 8 символов)

Min length: 8
Example:
hfy745Ykfd
user_name_input
string required

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

Example:
Алина
user_surname_input
string required

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

Example:
Солова

Responses

201 201

Пользователь успешно зарегистрирован

Body
application/json
Object
message
string
Example:
Вы успешно зарегистрированы в системе
user_id
string
Example:
9bb13bc1aa5f4c07bd5220602cdeaaa4
user_email
string
Example:
user@mail.ru
user_name
string
Example:
Алина
user_surname
string
Example:
Солова
400 400

Невалидные входные данные

Body
application/json
One of
Object
error
string
Example:
Тело запроса не может быть пустым
Object
error
string
Example:
Отсутствуют обязательные поля
missing_fields
Array of string
message
string
Object
error
string
Example:
Обязательные поля не могут быть пустыми
empty_fields
Array of string
message
string
Object
error
string
Example:
Некорректный формат email
message
string
Example:
Введите корректный email адрес (пример: user@example.com)
Object
error
string
Example:
Слишком короткий пароль
message
string
Example:
Пароль должен содержать минимум 8 символов
409 409

Пользователь с таким email уже существует

Body
application/json
Object
error
string
Example:
В системе уже существует аккаунт с введенным email.
500 500

Ошибка сервера

Body
application/json
Object
error
string
Example:
Ошибка сервера. Попробуйте повторить позже
Example 1
POST https://web-production-a0b7.up.railway.app/fte_records/register HTTP/1.1 

Content-Type: application/json

{
    "email_input": "user@mail.ru",
    "pwd_input": "hfy745Ykfd",
    "user_name_input": "Алина",
    "user_surname_input": "Солова"
}
Master Lists
Редактировать задачи в мастерсправочнике
PATCH /fte_records/master_list/update
Получить записи из мастер-справочника
GET /fte_records/master_list
Редактировать задачи в мастерсправочнике
PATCH /fte_records/master_list/update

Authentication

bearerAuth

Обновление названия задачи в мастер-справочнике

Request body

application/json
Object
task_id
string required

ID задачи

Example:
e602aef7134944009a86b07a7abeac44
new_task_name
string required

Новое название задачи (минимум 2 символа)

Min length: 2
Example:
Разработка и изменение модели

Responses

200 200

Задача успешно обновлена

Body
application/json
Object
message
string
Example:
Название задачи было успешно изменено.
400 400

Невалидные входные данные

Body
application/json
One of
Object
error
string
Example:
Тело запроса не может быть пустым
Object
error
string
Example:
Отсутствуют обязательные поля
missing_fields
Array of string
message
string
Object
error
string
Example:
Обязательные поля не могут быть пустыми
empty_fields
Array of string
message
string
Object
error
string
Example:
Некорректный формат new_task_name
message
string
Example:
Проверьте new_task_name. Должно быть длиньше 2 символов.
401 401

Ошибка авторизации

Body
application/json
Object
error
string
403 403

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

Body
application/json
Object
error
string
Example:
У вас нет доступа для редактирования названия задачи с указанным id.
404 404

Данные не найдены

Body
application/json
Object
error
string
500 500

Ошибка сервера

Body
application/json
Object
error
string
Example:
Ошибка сервера. Попробуйте повторить позже
Example 1
PATCH https://web-production-a0b7.up.railway.app/fte_records/master_list/update HTTP/1.1 

Content-Type: application/json

{
    "task_id": "e602aef7134944009a86b07a7abeac44",
    "new_task_name": "Разработка и изменение модели"
}
Получить записи из мастер-справочника
GET /fte_records/master_list

Authentication

bearerAuth

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

Responses

200 200

Успешное получение данных

Body
application/json
Object
master_list
Array
Object
subdivision_name
string
Example:
Отдел машинного обучения
tasks_json
Object
Example: 
{
  "e602aef7134944009a86b07a7abeac44" : "Разработка модели"
}
additional properties
string
401 401

Ошибка авторизации

Body
application/json
Object
error
string
Example:
Отсутствует токен.
404 404

Данные не найдены

Body
application/json
Object
error
string
Example:
Авторизация не найдена в системе.