GetDepartment (V2)

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

GET /V2/GetDepartment
Query Parameters:
  • boxId – идентификатор ящика организации в формате GUID.

  • departmentId – идентификатор подразделения организации.

Request Headers:
Status Codes:
  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 404 Not Found – не найдены организация или подразделение с указанным идентификатором.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

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

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

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

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

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

{
    "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 — изменяет данные подразделения организации (доступно только администраторам ящика)

Устаревшие версии метода: