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

GetDepartment (V2)

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

GET /V2/GetDepartment

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

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

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

Коды ответа

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

Тело ответа

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

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

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

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

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

{
"DepartmentId": "32cb2cd3-ed3a-403a-b220-7dfd59c757db",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Отдел продаж",
"Abbreviation": "ОП",
"Address": {
"RussianAddress": {
"Region": ""
},
"AddressCode": ""
},
"IsDisabled": false
}

См. также

Инструкции:

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

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

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

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

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