GetDepartments
к сведению
Вызов метода доступен только администраторам организации.
Возвращает список подразделений организации.
GET /admin/GetDepartments
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.page— номер страницы, которую нужно получить. Необязательный параметр, по умолчанию равен1.count— максимальное количество элементов, возвращаемых на одной странице в ответе. Не влияет на общее количество найденных подразделений DepartmentList.TotalCount. Принимает значения от 1 до 100, по умолчанию равен 100. Необязательный параметр.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у организации с указанным идентификаторомboxIdзакончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.404— не найден ящик с указанным идентификатором.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит список подразделений организации, отсортированный по дате создания — от старого к новому, представленный структурой DepartmentList.
Метод работает по следующим правилам:
- Метод не возвращает удаленные подразделения.
- Головное подразделение всегда первое в списке. При этом значение поля
CreationTimestampдля него равноnull.
Примеры использования
Пример HTTP-запроса:
GET /admin/GetDepartments?boxid={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"Departments": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"ParentDepartmentId": "",
"Name": "Головное подразделение",
"Abbreviation": "ГП",
"Routing": {
"Kpp": false,
"Address": false
},
"CreationTimestamp": {
"Ticks": 0
}
},
{
"Id": "6d710055-9b5d-4bc0-ba2f-9e54adda034e",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Дочернее подразделение",
"Abbreviation": "ДП",
"Routing": {
"Kpp": false,
"Address": false
},
"CreationTimestamp": {
"Ticks": 638568885150838885
}
},
{
"Id": "b651ed54-04d8-4ca8-99b5-960fba733147",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Подразделение 1",
"Abbreviation": "П1",
"Address": {
"RussianAddress": {
"Region": "50",
"City": "Дзержинский",
"Street": "Садовая",
"Building": "2",
"Block": "",
"Apartment": "",
"OtherInformation": ""
},
"AddressCode": ""
},
"Routing": {
"Kpp": false,
"Address": false
},
"CreationTimestamp": {
"Ticks": 638569024178105899
}
},
{
"Id": "32cb2cd3-ed3a-403a-b220-7dfd59c757db",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Подразделение 2",
"Abbreviation": "П2",
"Routing": {
"Kpp": false,
"Address": false
},
"CreationTimestamp": {
"Ticks": 638569024257522740
}
},
{
"Id": "17969b71-a3a1-4484-a4f0-5091931afc3d",
"ParentDepartmentId": "00000000-0000-0000-0000-000000000000",
"Name": "Бухгалтерия",
"Abbreviation": "Б",
"Kpp": "456701001",
"Routing": {
"Kpp": true,
"Address": false
},
"CreationTimestamp": {
"Ticks": 638833410039546296
}
}
],
"TotalCount": 5
}
См. также
Инструкции:
Методы для работы с подразделениями:
- CreateDepartment — создает подразделение организации (доступно только администраторам ящика)
- DeleteDepartment — удаляет подразделение организации (доступно только администраторам ящика)
- GetDepartment (V2) — возвращает данные подразделения организации по указанному идентификатору
- GetDepartments — возвращает список подразделений организации (доступно только администраторам ящика)
- UpdateDepartment — изменяет данные подразделения организации (доступно только администраторам ящика)