GetCounteragentGroups
Возвращает список групп контрагентов указанного ящика.
GET /GetCounteragentGroups
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.page— номер страницы, которую нужно получить. По умолчанию равен 1. Необязательный параметр.count— максимальное количество элементов, возвращаемых на одной странице в ответе. Не влияет на общее количество найденных групп контрагентовCounteragentGroupsList.TotalCount. Принимает значения от 1 до 100, по умолчанию равен 100. Необязательный параметр.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя нет права работать со списком контрагентов (см. OrganizationUserPermissions.CanManageCounteragents).405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит структуру CounteragentGroupsList:
message CounteragentGroupsList {
repeated CounteragentGroup Groups = 1;
required int32 TotalCount = 2;
}
Groups— список групп контрагентов, представленных структурой CounteragentGroup.TotalCount— общее количество найденных групп контрагентов.
Метод доступен только сотрудникам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.
Метод не возвращает удаленные группы контрагентов.
Обратите внимание, что кроме созданных групп метод возвращает группу «По умолчанию» с идентификатором 00000000-0000-0000-0000-000000000000. Это созданная Диадоком группа, в которую автоматически добавляются все контрагенты организации. Ее нельзя удалить, для нее можно только настроить список подразделений, в которые контрагенты группы могут отправлять документы, — сделать это можно с помощью метода UpdateCounteragentGroup.
Примеры использования
Пример HTTP-запроса:
GET /GetCounteragentGroups?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример ответа:
{
"Groups": [
{
"CounteragentGroupId": "00000000-0000-0000-0000-000000000000",
"Name": "По умолчанию"
},
{
"CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
"Name": "Группа",
"Departments": {
"DepartmentIds": [
"6d710055-9b5d-4bc0-ba2f-9e54adda034e"
]
}
},
{
"CounteragentGroupId": "db0c29b8-bbd3-42a0-aa8b-beba1aeabdf4",
"Name": "Группа2"
}
],
"TotalCount": 3
}
См. также
Инструкции:
Методы для работы с группами контрагентов:
- AddCounteragentToGroup — добавляет контрагента в группу
- CreateCounteragentGroup — создает группу контрагентов
- DeleteCounteragentGroup — удаляет группу контрагентов
- GetCounteragentGroup — возвращает данные группы контрагентов по указанному идентификатору
- GetCounteragentGroups — возвращает список групп контрагентов
- GetCounteragentsFromGroup — возвращает список контрагентов, состоящих в указанной группе
- UpdateCounteragentGroup — изменяет данные группы контрагентов