GetCounteragentsFromGroup
Возвращает список контрагентов, состоящих в указанной группе.
GET /GetCounteragentsFromGroup
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.counteragentGroupId— идентификатор группы контрагентовafterIndexKey— ключ для постраничного получения списка найденных контрагентов, указывающий на начало очередной страницы. Ключ может содержать недопустимые символы, поэтому должен быть закодирован в URL-формат. Необязательный параметр.count— максимальное количество элементов, возвращаемых на одной странице в ответе. Не влияет на общее количество найденных контрагентовCounteragentFromGroupResponse.TotalCount. Принимает значения от 1 до 100, по умолчанию равен 100. Необязательный параметр.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.404— не найдена группа контрагентов с указанным идентификатором.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит структуру CounteragentFromGroupResponse:
message CounteragentFromGroupResponse {
repeated string CounteragentBoxId = 1;
required int32 TotalCount = 2;
optional string AfterIndexKey = 3;
}
CounteragentBoxId— список идентификаторов ящиков контрагентов.TotalCount— количество найденных контрагентов в группе.AfterIndexKey— ключ для постраничного получения списка найденных контрагентов. Его можно передавать в качестве параметраafterIndexKeyв методGetCounteragentsFromGroup: ключ может содержать недопустимые символы, поэтому при вызове метода должен быть закодирован в URL-формат.
Метод доступен только администраторам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.
Метод вернет только идентификаторы контрагентов со статусом CounteragentStatus = IsMyCounteragent. Узнать статус контрагента можно с помощью метода GetOrganizationsByInnList (V2).
Список контрагентов CounteragentBoxId в ответе CounteragentFromGroupResponse может содержать не больше 100 элементов. Поэтому:
-
Если найденных контрагентов меньше 100, то метод вернет их полностью.
-
Если найденных контрагентов больше 100, то в ответе
CounteragentBoxIdвернутся только первые 100 элементов. При этом параметрTotalCountбудет содержать общее количество найденных контрагентов.В этом случае получить весь список найденных контрагентов можно постранично. Для этого вызывайте метод
GetCounteragentsFromGroupс теми же параметрами запроса и с указанием параметраafterIndexKeyдо тех пор, пока список контрагентов не будет вычитан полностью. В качестве параметраafterIndexKeyнужно указывать ключ контрагента из поляCounteragentFromGroupResponse.AfterIndexKey, предварительно закодировав его в URL-формат.
В зависимости от значения параметра afterIndexKey метод работает следующим образом:
- Если в запросе отсутствует параметр
afterIndexKey, то метод вернет начало списка найденных контрагентов. - Если в запросе указан параметр
afterIndexKey, то метод вернет список контрагентов, следующих за контрагентом с ключомafterIndexKey; контрагент с ключомafterIndexKeyв этот список не попадает.
Примеры использования
Пример HTTP-запроса:
GET /GetCounteragentsFromGroup?boxId={{boxId}}&counteragentGroupId=ecd591dd-b56f-4178-ab4a-8a5532f231f7 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"CounteragentBoxId": [
"1f208d03-2a60-4f64-91b1-b7aad54cfaf3"
],
"TotalCount": 1,
"AfterIndexKey": "08DCA6534D6F9E72038D201F602A644F91B1B7AAD54CFAF3"
}
См. также
Инструкции:
Методы для работы с группами контрагентов:
- AddCounteragentToGroup — добавляет контрагента в группу
- CreateCounteragentGroup — создает группу контрагентов
- DeleteCounteragentGroup — удаляет группу контрагентов
- GetCounteragentGroup — возвращает данные группы контрагентов по указанному идентификатору
- GetCounteragentGroups — возвращает список групп контрагентов
- GetCounteragentsFromGroup — возвращает список контрагентов, состоящих в указанной группе
- UpdateCounteragentGroup — изменяет данные группы контрагентов