Skip to content

Получить список анкет

Получить список анкет#

Ручка#

POST /worksheet/v1/fetch_worksheet

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

Среда URL
🧪 Dev https://gateway.devterra.ru/admin/worksheet/v1/fetch_worksheet
🚀 Prod https://mobile-api.terraprod.ru/admin/worksheet/v1/fetch_worksheet

Пример тела запроса#

{
    "filters": {
        "allRoles": true,
        "cityID": [
            0
        ],
        "competence": [
            "string"
        ],
        "contacts": [
            "string"
        ],
        "countryID": [
            0
        ],
        "districtID": [
            0
        ],
        "employment": [
            "string"
        ],
        "mentorCategory": [
            0
        ],
            "roleIDs": [
            0
        ],
            "salaryLevel": [
            0
        ],
            "staffCount": [
            0
        ],
            "turnoverLevel": [
            0
        ],
        "userNames": [
            "string"
        ],
        "userUUIDs": [
            "string"
        ],
        "yearsOnBusiness": [
            0
        ]
    },
    "pagination": {
        "limit": 0,
        "page": 0
    }
}
Поле Тип Описание Обязательное Пример
allRoles bool Флаг, все ли роли ❌ "false"
competencies []string Навык пользователя ❌ ["...", "..."]
contacts []string Контакты пользователя ❌ [{...}, {...}]
countryID []int32 Идентификатор страны ❌ [1]
districtID []int32 Идентификатор округа ❌ [1]
employments []string Ниши пользователя ❌ ["...", "..."]
mentorCategory []int32 Идентификатор категорий менторства ❌ [1]
roleIDs []int32 Идентификатор роли ❌ [1]
salaryLevel []int32 Идентификатор уровня заработной платы ❌ [1]
staffCount []int32 Идентификатор уровня количества сотрудников ❌ [1]
turnoverLevel []int32 Идентификатор уровня оборота ❌ [1]
userNames []string Имена пользователей ❌ ["...", "..."]
userUUIDs []string Идентификаторы пользователей ❌ ["...", "..."]
yearsOnBusiness []int32 Идентификатор уровня лет в бизнесе ❌ [1]

Пример тела ответа#

{
    "pagination": {
        "currentPage": 0,
        "itemsPerPage": 0,
        "totalItems": 0,
        "totalPages": 0
    },
    "result": [
        {
            "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"
            }
        }
    ]
}

pagination#

Поле Тип Описание Обязательное Пример
ItemsPerPage int32 Количество элементов на странице ❌ 5
TotalItems int32 Общее количество элементов ❌ 5
CurrentPage int32 Текущая страница ❌ 5
TotalPages int32 Общее количество страниц ❌ 5

worksheets#

Поле Тип Описание Обязательное Пример
aboutMe string О пользователе ❌ "..."
competencies []*object Навык пользователя ❌ [{...}, {...}]
contacts []*object Контакты пользователя ❌ [{...}, {...}]
employments []*object Ниша пользователя ❌ [{...}, {...}]
firstName string Имя пользователя ❌ "..."
goalsForYear *string Цели на год ❌ "..."
keyAchievements *string Ключевые достижения ❌ "..."
lastName string Фамилия пользователя ❌ "..."
location []*object Локация пользователя ❌ [{...}, {...}]
mentorCategory int32 Категория наставника ❌ 1
mentorYearsCount *object Количество лет в менторстве ❌ {YearsCount: 10, Description: "..."}
middleName string Отчество пользователя ❌ "..."
photo *object Фото пользователя ❌ {...]
roleID int32 Тип роли ❌ 1
salaryLevel *object Уровень заработной платы пользователя ❌ {Id: 1, Name: "...", Locale: "ru"}
staffCount *object Количество сотрудников ❌ {Id: 1, Name: "...", Locale: "ru"}
turnoverLevel *object Уровень оборота компании ❌ {Id: 1, Name: "...", Locale: "ru"}
userUUID string Уникальный идентификатор пользователя ❌ "8a87d1a5-5bce-4361-a2e6-8b5517c81212"
uuid string Уникальный идентификатор анкеты ❌ "8a87d1a5-5bce-4361-a2e6-8b5517c81212"
videoCard *string Карточка с видео ❌ "..."
yearsOnBusiness *object Опыт в бизнесе ❌ {Id: 1, Name: "...", Locale: "ru"}

competencies, employments#

Поле Тип Описание Обязательное Пример
description string Описание ❌ "..."
name string Название ❌ "..."
uuid string Уникальный идентификатор навыка (ниши) ❌ "..."

contacts#

Поле Тип Описание Обязательное Пример
contact string Контакт ❌ "..."
contactType int32 Тип контакта ❌ "..."

location#

Поле Тип Описание Обязательное Пример
cityID *int32 Идентификатор города ❌ 1
countryID *int32 Идентификатор страны ❌ 1
districtID *int32 Идентификатор округа ❌ 1

mentorYearsCount#

Поле Тип Описание Обязательное Пример
description string Описание ❌ "..."
yearsCount int32 Количество лет ❌ 5

photo#

Поле Тип Описание Обязательное Пример
coord object Ширина и высота фото ❌ см. ниже
url string Ссылка на фото ❌ "..."

coord#

Поле Тип Описание Обязательное Пример
height int64 Высота ❌ 256
width int64 Ширина ❌ 256
x int64 Координаты по оси X ❌ 256
y int64 Координаты по оси Y ❌ 256

salaryLevel, staffCount, turnoverLevel, yearsOnBusiness#

Поле Тип Описание Обязательное Пример
id int32 Идентификатор ❌ 5
name string Название ❌ "..."
rawName string Сырое имя ❌ "..."