GetDepartments

Примечание

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

Возвращает список подразделений организации.

GET /admin/GetDepartments
Query Parameters:

  • boxId – идентификатор ящика организации.

  • page – номер страницы, которую нужно получить. Необязательный параметр, по умолчанию равен 1.

  • count – максимальное количество элементов, возвращаемых на одной странице в ответе. Не влияет на общее количество найденных подразделений DepartmentList.TotalCount. Принимает значения от 1 до 100, по умолчанию равен 100. Необязательный параметр.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

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

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

  • 402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.

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

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

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

Response Body:

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

Примечания:

  • Метод не возвращает удаленные подразделения.

  • Головное подразделение всегда первое в списке. При этом значение поля CreationTimestamp для него равно null.

См. также

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

  • GetDepartment (V2) — возвращает данные подразделения организации по указанному идентификатору

  • GetDepartment — возвращает данные подразделения организации

  • GetDepartments — возвращает список подразделений организации

  • CreateDepartment — создает подразделение организации

  • UpdateDepartment — изменяет данные подразделения организации

  • DeleteDepartment — удаляет подразделение оранизации