Оплата труда
Атрибут | Значение |
---|---|
Название | info-radar-salary-data |
Тип | Адаптер для получения данных о зарплате в компании |
Наименование | Оплата труда |
Версия | Реализовано 21.07.2025 |
Сервис для получения получения данных о зарплате в компании.
Общая информация
Цель документации — обеспечить полное понимание и возможность эффективного использования сервиса как для конечных пользователей, так и для разработчиков.
Сервис является частью платформы Агредатор. Перед изучением данной документации ознакомьтесь со следующими обязательными документами по интеграции с платформой:
Параметр | Название | Тип | Обязательное | Пример |
---|---|---|---|---|
service | Имя сервиса (всегда info-radar-salary-data ) |
string | + | info-radar-salary-data |
type | Тип запроса | string (enum) | + | company_data |
data | Данные запроса | object | + | см. ниже |
Типы запросов type
type | Значение |
---|---|
company_data | Получить данные о зарплате в компании. |
Структура data
Параметр | Название | Тип | Обязательное | Пример |
---|---|---|---|---|
EntityId | Идентификатор лица | string(uuid) | + | "3fa85f64-5717-4562-b3fc-2c963f66afa6" |
Page | Номер страницы | integer | - | 1 |
Структура элементов data
EntityId
Описаниe: Идентификатор лица.
Тип данных: string (uuid)
Обязательное: +
Пример: 3fa85f64-5717-4562-b3fc-2c963f66afa6
Page
описание: Номер страницы для постраничного получения данных.
Тип данных: integer
Обязательное: нет
Пример: 1
Параметры ответа
Параметр | Название | Обязательное | Тип | Пример |
---|---|---|---|---|
success | Статус запроса | + | string | true |
result | Хеш с результатом | - | object | См. ниже |
exception | Ошибка | - | string | Что-то пошло не так |
Параметры result
Поле | Назначение | Тип | Обязательное | Пример |
---|---|---|---|---|
CurrentPage | Номер текущей страницы | integer | + | 1 |
PageSize | Макс. кол-во элементов на странице | integer | + | 10 |
TotalPageCount | Общее кол-во страниц | integer | + | 1 |
TotalItemCount | Общее кол-во найденных элементов | integer | + | 4 |
Items | Массив найденных элементов | array[object] | + | Items |
Элемент массива
Items
Поле | Назначение | Тип | Пример | |
---|---|---|---|---|
Fund | Размер фонда (в рублях) | number | 51322367000 | |
Headcount | Количество сотрудников | number | null | null |
AverageSalary | Средняя зарплата (в рублях) | number | null | 31100 |
Year | Год | integer | 2021 |
Пример json запроса
{
"service": "info-radar-salary-data",
"type": "company_data",
"data": {
"EntityId": "4dcf1f84-8979-40f3-9a04-18b6b7a32e5a",
"Page": 1,
}
}
Примеры json ответов
{
"success": true,
"result": {
"CurrentPage": 1,
"PageSize": 10,
"TotalPageCount": 1,
"TotalItemCount": 4,
"Items": [
{
"Fund": 51322367000,
"Headcount": null,
"AverageSalary": null,
"Year": 2021
},
{
"Fund": 49481746000,
"Headcount": null,
"AverageSalary": null,
"Year": 2020
},
{
"Fund": 47754275000,
"Headcount": null,
"AverageSalary": null,
"Year": 2019
},
{
"Fund": 46646550000,
"Headcount": null,
"AverageSalary": null,
"Year": 2018
}
]
}
}
Пример ошибки:
{
"success": false,
"exception": "Что-то пошло не так"
}