Получение учеников по выбранному потоку

Описание

Получение списка студентов, зарегистрированных на конкретный запуск. Метод возвращает основную информацию о регистрации студента, включая статус, дату создания и подробную информацию о пользователе. Также доступна фильтрация по статусу регистрации, имени, занятости и компетенциям.

Ручка

POST /school_flows/v1/{uuid}/students

Полный адрес в сети

Среда	URL
🧪 Dev	https://gateway.devterra.ru/admin/school_flows/v1/04cde00c-7c00-4e49-a8e8-8f98b74bc63a/students
🚀 Prod	https://mobile-api.terraprod.ru/admin/school_flows/v1/04cde00c-7c00-4e49-a8e8-8f98b74bc63a/students

Тело запроса

Корневой объект

Поле	Тип	Описание	Обязательное
pagination	object	Информация о пагинации	✅
result	array	Список результатов	✅

pagination

Поле	Тип	Описание	Обязательное
currentPage	int	Текущая страница	✅
itemsPerPage	int	Кол-во элементов на странице	✅
totalItems	int	Общее кол-во элементов	✅
totalPages	int	Общее кол-во страниц	✅

result[]

Поле	Тип	Описание	Обязательное
id	int	ID записи	✅
createdAt	string	Дата создания	✅
updatedAt	string	Дата обновления	✅
studentUUID	string	UUID ученика	✅
status	object	Статус ученика	✅
studentInfo	object	Информация об ученике	✅

status

Поле	Тип	Описание	Обязательное
alias	string	Краткое имя	✅
name	string	Полное имя	✅

studentInfo

Поле	Тип	Описание	Обязательное
firstName	string	Имя	✅
lastName	string	Фамилия	✅
middleName	string	Отчество	❌
birthday	string	Дата рождения (дд.мм.гггг)	✅
aboutMe	string	О себе	❌
bans	string	Причины блокировки	❌
isBanned	boolean	Заблокирован ли пользователь	✅
enableNotification	boolean	Уведомления включены	✅
useTOTP	boolean	Используется TOTP	✅
userID	string	Идентификатор пользователя	✅
userEventID	int	ID события	✅
userEventName	string	Название события	✅
createdAt	string	Дата создания профиля	✅
updatedAt	string	Дата обновления профиля	✅

location

Поле	Тип	Описание	Обязательное
countryID	int	ID страны	✅
countryName	string	Название страны	✅
cityID	int	ID города	✅
cityName	string	Название города	✅
districtID	int	ID района	✅
districtName	string	Название района	✅
addressName	string	Название адреса	❌

contactInfo[]

Поле	Тип	Описание	Обязательное
contact	string	Контакт	✅
contactName	string	Название контакта	✅
contactType	int	Тип контакта	✅
isVerified	boolean	Верифицирован ли он	✅

photo

Поле	Тип	Описание	Обязательное
photoBase64	string	Фото в base64	❌
coord	object	Координаты кадра	❌

coord поля:

Поле	Тип	Описание
x	int	Смещение по X
y	int	Смещение по Y
width	int	Ширина
height	int	Высота

userRoles[]

Поле	Тип	Описание	Обязательное
role	string	Название роли	✅
permission	int	Уровень доступа	✅
info	object	Доп. сведения	❌

info поля:

Поле	Тип	Описание
mentor_level	int	Уровень наставника
salary	int	Уровень дохода

worksheet[]

Поле	Тип	Описание	Обязательное
firstName	string	Имя	✅
lastName	string	Фамилия	✅
middleName	string	Отчество	❌
aboutMe	string	О себе	❌
keyAchievements	string	Достижения	❌
goalsForYear	string	Цели	❌
mentorCategory	int	Категория наставника	❌
location	object	Локация	❌
competencies	array	Компетенции	❌
employments	array	Сферы занятости	❌
contacts	array	Контакты	❌
photo	object	Фото	❌
userUUID	string	UUID пользователя	❌
uuid	string	UUID анкеты	❌
videoCard	string	Видео-визитка	❌
roleID	int	ID роли	❌
salaryLevel	object	Уровень дохода	❌
staffCount	object	Кол-во сотрудников	❌
turnoverLevel	object	Уровень оборота	❌
yearsOnBusiness	object	Стаж в бизнесе	❌

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

[
  {
    "pagination": {
      "currentPage": 0,
      "itemsPerPage": 0,
      "totalItems": 0,
      "totalPages": 0
    },
    "result": [
      {
        "createdAt": "string",
        "id": 0,
        "status": {
          "alias": "string",
          "name": "string"
        },
        "studentInfo": {
          "aboutMe": "string",
          "background": {
            "competence": "string",
            "employment": "string"
          },
          "bans": "string",
          "birthday": "02.01.2006",
          "contactInfo": [
            {
              "contact": "string",
              "contactName": "string",
              "contactType": 0,
              "isVerified": true
            }
          ],
          "createdAt": "2024-11-05T18:30:00+03:00",
          "enableNotification": true,
          "firstName": "string",
          "isBanned": true,
          "lastName": "string",
          "location": {
            "addressName": "string",
            "cityID": 0,
            "cityName": "string",
            "countryID": 0,
            "countryName": "string",
            "districtID": 0,
            "districtName": "string"
          },
          "middleName": "string",
          "photo": {
            "coord": {
              "height": 0,
              "width": 0,
              "x": 0,
              "y": 0
            },
            "photoBase64": "string"
          },
          "updatedAt": "2024-11-05T18:30:00+03:00",
          "useTOTP": true,
          "userEventID": 0,
          "userEventName": "string",
          "userID": "string",
          "userRoles": [
            {
              "info": {
                "mentor_level": 0,
                "salary": 0
              },
              "permission": 0,
              "role": "string"
            }
          ],
          "worksheet": [
            {
              "aboutMe": "string",
              "competencies": [
                {
                  "description": "string",
                  "name": "string",
                  "uuid": "string"
                }
              ],
              "contacts": [
                {
                  "contact": "string",
                  "contactType": 0
                }
              ],
              "employments": [
                {
                  "description": "string",
                  "name": "string",
                  "uuid": "string"
                }
              ],
              "firstName": "string",
              "goalsForYear": "string",
              "keyAchievements": "string",
              "lastName": "string",
              "location": {
                "cityID": 0,
                "countryID": 0,
                "districtID": 0
              },
              "mentorCategory": 0,
              "mentorYearsCount": {
                "description": "string",
                "yearsCount": 0
              },
              "middleName": "string",
              "photo": {
                "coord": {
                  "height": 0,
                  "width": 0,
                  "x": 0,
                  "y": 0
                },
                "url": "string"
              },
              "roleID": 0,
              "salaryLevel": {
                "id": 0,
                "name": "string",
                "rawName": "string"
              },
              "staffCount": {
                "id": 0,
                "name": "string",
                "rawName": "string"
              },
              "turnoverLevel": {
                "id": 0,
                "name": "string",
                "rawName": "string"
              },
              "userUUID": "string",
              "uuid": "string",
              "videoCard": "string",
              "yearsOnBusiness": {
                "id": 0,
                "name": "string",
                "rawName": "string"
              }
            }
          ]
        },
        "studentUUID": "string",
        "updatedAt": "string"
      }
    ]
  }
]

Пример JSON ответа

[
  {
    "pagination": {
      "currentPage": 0,
      "itemsPerPage": 0,
      "totalItems": 0,
      "totalPages": 0
    },
    "result": [
      {
        "createdAt": "string",
        "id": 0,
        "status": {
          "alias": "string",
          "name": "string"
        },
        "studentInfo": {
          "aboutMe": "string",
          "background": {
            "competence": "string",
            "employment": "string"
          },
          "bans": "string",
          "birthday": "02.01.2006",
          "contactInfo": [
            {
              "contact": "string",
              "contactName": "string",
              "contactType": 0,
              "isVerified": true
            }
          ],
          "createdAt": "2024-11-05T18:30:00+03:00",
          "enableNotification": true,
          "firstName": "string",
          "isBanned": true,
          "lastName": "string",
          "location": {
            "addressName": "string",
            "cityID": 0,
            "cityName": "string",
            "countryID": 0,
            "countryName": "string",
            "districtID": 0,
            "districtName": "string"
          },
          "middleName": "string",
          "photo": {
            "coord": {
              "height": 0,
              "width": 0,
              "x": 0,
              "y": 0
            },
            "photoBase64": "string"
          },
          "updatedAt": "2024-11-05T18:30:00+03:00",
          "useTOTP": true,
          "userEventID": 0,
          "userEventName": "string",
          "userID": "string",
          "userRoles": [
            {
              "info": {
                "mentor_level": 0,
                "salary": 0
              },
              "permission": 0,
              "role": "string"
            }
          ],
          "worksheet": [
            {
              "aboutMe": "string",
              "competencies": [
                {
                  "description": "string",
                  "name": "string",
                  "uuid": "string"
                }
              ],
              "contacts": [
                {
                  "contact": "string",
                  "contactType": 0
                }
              ],
              "employments": [
                {
                  "description": "string",
                  "name": "string",
                  "uuid": "string"
                }
              ],
              "firstName": "string",
              "goalsForYear": "string",
              "keyAchievements": "string",
              "lastName": "string",
              "location": {
                "cityID": 0,
                "countryID": 0,
                "districtID": 0
              },
              "mentorCategory": 0,
              "mentorYearsCount": {
                "description": "string",
                "yearsCount": 0
              },
              "middleName": "string",
              "photo": {
                "coord": {
                  "height": 0,
                  "width": 0,
                  "x": 0,
                  "y": 0
                },
                "url": "string"
              },
              "roleID": 0,
              "salaryLevel": {
                "id": 0,
                "name": "string",
                "rawName": "string"
              },
              "staffCount": {
                "id": 0,
                "name": "string",
                "rawName": "string"
              },
              "turnoverLevel": {
                "id": 0,
                "name": "string",
                "rawName": "string"
              },
              "userUUID": "string",
              "uuid": "string",
              "videoCard": "string",
              "yearsOnBusiness": {
                "id": 0,
                "name": "string",
                "rawName": "string"
              }
            }
          ]
        },
        "studentUUID": "string",
        "updatedAt": "string"
      }
    ]
  }
]