Метод sabyCandidate.List возвращает список кандидатов.
Тип запроса: GET
Адрес запроса: https://api.sbis.ru/hr-api/service/
Параметры запроса
Параметр | Тип | Описание | ||
Filter* | hashtable | параметры фильтрации. Может быть пустым | ||
| Key | string array | список идентификаторов кандидатов | |
Category | integer array | список идентификаторов пользовательских категорий | ||
Status | string | статус кандидата. Возможные значения: «New» — новый, «InWork» — в работе, «Accepted» — принят, «Rejected» — отклонен | ||
Search | hashtable | параметры поиска кандидата | ||
| Param | string | укажите, по какому параметру искать кандидата в базе Saby. Возможные значения: «Name» — ФИО, «Phone» — телефон, «Email» — электронная почта | |
Value | string | значение для строки поиска | ||
Additional | string array | укажите, какие дополнительные данные необходимо получить. Возможные значения: «Contacts» — контактные данные, «Source» — источник, «SabyLink» — ссылка на карточку кандидата в Saby | ||
Navigation | hashtable | параметры навигации. Возможные значения: «постраничная», «курсорная» | ||
| Limit | integer | количество записей на странице | |
Page | integer | номер страницы | ||
Version | string | версия API. Используется для поддержки обратной совместимости | ||
Результат
Параметр | Тип | Описание | ||
Data | hashtable | набор данных | ||
| Key | string | идентификатор кандидата | |
Surname | string | фамилия | ||
Name | string | имя | ||
Patronymic | string | отчество | ||
Gender | string | пол кандидата. Возможные значения: «M», «F» | ||
Birthdate | string | дата рождения | ||
Position | string | название желаемой должности | ||
Salary | hashtable | данные о зарплате | ||
| From | integer | нижнее значение зарплатного диапазона | |
To | integer | верхнее значение зарплатного диапазона | ||
Currency | string | код валюты, в которой должна выдаваться зарплата. Например, 643 — российский рубль | ||
Employment | string array | типы занятости. Возможные значения: «Full» — полная, «Partial» — частичная, «Temporary» — временная, «Volunteering» — волонтерство, «Intership» — стажировка | ||
Schedule | string array | график работы. Возможные значения: «FullDay» — полный день, «Flexible» — гибкий, «Shift» — сменный график, «Remote» — удаленная работа, «Tour» — вахтовый метод | ||
BusinessTrip | string | готовность кандидата к командировкам. Возможные значения: «NotReady» — не готов, «Ready» — готов, «Wants» — желательно | ||
Relocation | string | готовность кандидата к переезду. Возможные значения: «NotReady» — не готов, «Ready» — готов, «Wants» — желательно | ||
Address | string | адрес | ||
Comment | string | текст примечания | ||
Category | hashtable | данные пользовательских категорий | ||
| Key | integer | идентификатор категории | |
Name | string | название категории | ||
Source | hashtable | источник, откуда узнали о кандидате. Например, с работного сайта | ||
| Key | integer | идентификатор источника | |
Name | string | название источника | ||
SabyLink | string | ссылка на карточку в Saby | ||
Status | string | статус кандидата. Возможные значения: «New» — новый, «InWork» — в работе, «Accepted» — принят, «Rejected» — отклонен | ||
Contact | hashtable | контактные данные кандидата | ||
| MobilePhone | string array | мобильные телефоны | |
HomePhone | string array | домашние телефоны | ||
string array | адреса электронной почты | |||
Telegram | string array | аккаунт Telegram | ||
string array | номер WhatsApp | |||
Viber | string array | номер Viber | ||
NavResult | hashtable | результат навигации | ||
| More | bool | признак наличия данных. Возможные значения: true, false | |
NextPosition | integer | курсор для навигации | ||