GetEmployees
Вызов метода доступен только администраторам организации.
Возвращает список сотрудников организации.
В ответе метода вернутся все сотрудники организации: в списке будут перечислены сначала зарегистрированные, а затем незарегистрированные сотрудники, упорядоченные по дате создания. Признак регистрации хранится в структуре UserV2 в поле IsRegistered.
Чтобы получить список только зарегистрированных сотрудников, используйте метод GetOrganizationUsers (V2).
Обратите внимание, что после регистрации у незарегистрированного пользователя сменится идентификатор — значение UserId в структуре UserV2. Это значит, что при повторном вызове метода после регистрации пользователя вернется другое значение.
GET /GetEmployees
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.page— номер страницы, начиная с 1. По умолчанию равен 1. Необязательный параметр.count— максимальное количество элементов, возвращаемых на одной странице в ответе. Не влияет на общее количество найденных сотрудников EmployeeList.TotalCount. Принимает значения от 1 до 50, по умолчанию равен 50. Необязательный параметр.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.404— не найден ящик с указанным идентификатором.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит список сотрудников организации, представленный структурой EmployeeList.
Список сотрудников возвращается постранично. Для навигации используйте параметр page.
Примеры использования
Пример HTTP-запроса:
GET /GetEmployees?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"Employees": [
{
"User": {
"UserId": "6dc8c481-7cec-4675-8fd3-711cbe752eaa",
"Login": "email@example.com",
"FullName": {
"LastName": "Иванов",
"FirstName": "Иван",
"MiddleName": "Иванович"
},
"IsRegistered": true
},
"Permissions": {
"UserDepartmentId": "00000000-0000-0000-0000-000000000000",
"IsAdministrator": false,
"DocumentAccessLevel": "DepartmentAndSubdepartments",
"SelectedDepartmentIds": [],
"Actions": [
{ "Name": "CreateDocuments", "IsAllowed": true },
{ "Name": "DeleteRestoreDocuments", "IsAllowed": true },
{ "Name": "SignDocuments", "IsAllowed": true },
{ "Name": "AddResolutions", "IsAllowed": false },
{ "Name": "RequestResolutions", "IsAllowed": false },
{ "Name": "ManageCounteragents", "IsAllowed": true }
],
"AuthorizationPermission": {
"IsBlocked": false
}
},
"Position": "Бухгалтер",
"CanBeInvitedForChat": false,
"CreationTimestamp": {
"Ticks": 638780603013048865
}
},
{
"User": {
"UserId": "4b5a02e7-1b9a-4d97-8dc7-1c7eed1ccbfc",
"Login": "charentoon@gmail.com",
"FullName": {
"LastName": "Петров",
"FirstName": "Петр",
"MiddleName": "Петрович"
},
"IsRegistered": true
},
"Permissions": {
"UserDepartmentId": "17969b71-a3a1-4484-a4f0-5091931afc3d",
"IsAdministrator": true,
"DocumentAccessLevel": "DepartmentAndSubdepartments",
"SelectedDepartmentIds": [],
"Actions": [
{ "Name": "CreateDocuments", "IsAllowed": true },
{ "Name": "DeleteRestoreDocuments", "IsAllowed": true },
{ "Name": "SignDocuments", "IsAllowed": true },
{ "Name": "AddResolutions", "IsAllowed": true },
{ "Name": "RequestResolutions", "IsAllowed": true },
{ "Name": "ManageCounteragents", "IsAllowed": true }
],
"AuthorizationPermission": {
"IsBlocked": false
}
},
"Position": "Главный бухгалтер",
"CanBeInvitedForChat": true,
"CreationTimestamp": {
"Ticks": 638781280420601889
}
}
],
"TotalCount": 9
}
Пример запроса с использованием C# SDK:
var employees = new List<Employee>();
for (var page = 1;; page++)
{
var employeeList = api.GetEmployees(token, boxId, page, count: 10);
employees.AddRange(employeeList.Employees);
Console.WriteLine("{0}/{1}", employees.Count, employeeList.TotalCount);
if (employeeList.Employees.Count == 0 || employees.Count >= employeeList.TotalCount)
{
break;
}
}
См. также
Инструкции:
Методы для работы с сотрудниками:
- CreateEmployee — добавляет в организацию сотрудника с указанными реквизитами (доступно только администраторам ящика)
- DeleteEmployee — удаляет сотрудника организации (доступно только администраторам ящика)
- GetEmployee — возвращает данные сотрудника организации по указанному идентификатору (доступно только администраторам ящика)
- GetEmployees — возвращает список сотрудников указанной организации (доступно только администраторам ящика)
- GetEmployeesByExternalId — возвращает список сотрудников организации по идентификатору учетной записи в системе SSO-провайдера (доступно только администраторам ящика)
- GetMyEmployee — возвращает данные сотрудника организации, от имени которого вызывается метод
- GetSubscriptions — возвращает информацию о подписках сотрудника организации на почтовые уведомления
- UpdateEmployee — изменяет данные сотрудника организации (доступно только администраторам ящика)
- UpdateSubscriptions — изменяет подписки сотрудника организации на почтовые уведомления