Перейти к основному содержимому

GetDepartment

warning

Вызов метода доступен только администраторам организации.

Метод устарел и будет удален из API после 10 ноября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода — GetDepartment (V2).

Возвращает данные подразделения организации по указанному идентификатору.

GET /admin/GetDepartment

Параметры запроса

  • boxId — идентификатор ящика организации в формате GUID.
  • departmentId — идентификатор подразделения организации.

Заголовки запроса

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у организации с указанным идентификатором boxId закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.
  • 404 — не найдены организация или подразделение с указанным идентификатором.
  • 405 — используется неподходящий HTTP-метод.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

Тело ответа содержит доступные для администратора данные подразделения, представленные структурой Department.

Примеры использования

Пример HTTP-запроса:

GET /admin/GetDepartment?boxid={{boxId}}&departmentid={{departmentid}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

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

{
"Id": "32cb2cd3-ed3a-403a-b220-7dfd59c757db",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Отдел продаж",
"Abbreviation": "ОП",
"Routing": {
"Kpp": false,
"Address": false
},
"CreationTimestamp": {
"Ticks": 638569024257522740
}
}

Пример запроса с использованием C# SDK:

к сведению

В SDK соответствующий метод имеет название GetDepartmentByFullId. Метод GetDepartment в SDK соответствует методу API GetDepartment (V2).

var department = api.GetDepartmentByFullId(token, boxId, departmentId);

См. также

Инструкции:

Методы для работы с подразделениями:

  • CreateDepartment — создает подразделение организации (доступно только администраторам ящика)
  • DeleteDepartment — удаляет подразделение организации (доступно только администраторам ящика)
  • GetDepartment (V2) — возвращает данные подразделения организации по указанному идентификатору
  • GetDepartments — возвращает список подразделений организации (доступно только администраторам ящика)
  • UpdateDepartment — изменяет данные подразделения организации (доступно только администраторам ящика)

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года