Перейти к основному содержимому

GetCounteragentGroup

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

GET /GetCounteragentGroup

Параметры запроса

  • boxId — идентификатор ящика организации в формате GUID.
  • counteragentGroupId — идентификатор группы контрагентов.

Заголовки запроса

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя нет права работать со списком контрагентов (см. OrganizationUserPermissions.CanManageCounteragents).
  • 404 — не найдена группа контрагентов с указанным идентификатором.
  • 405 — используется неподходящий HTTP-метод.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

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

Метод доступен только сотрудникам с доступом к ящику и разрешением OrganizationUserPermissions.CanManageCounteragents, которое позволяет видеть списки контрагентов и работать с ними.

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

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

GET /GetCounteragentGroup?boxId={{boxId}}&counteragentGroupId=ecd591dd-b56f-4178-ab4a-8a5532f231f7 HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

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

{
"CounteragentGroupId": "ecd591dd-b56f-4178-ab4a-8a5532f231f7",
"Name": "Группа",
"Departments": {
"DepartmentIds": [
"b651ed54-04d8-4ca8-99b5-960fba733147",
"32cb2cd3-ed3a-403a-b220-7dfd59c757db"
]
}
}

См. также

Инструкции:

Методы для работы с группами контрагентов:

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года