GetCounteragentGroups

Метод GetCounteragentGroups возвращает список групп контрагентов указанной организации.

GET /GetCounteragentGroups
Query Parameters:

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

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

  • count – количество групп контрагентов на одной странице. Может принимать значение от 1 до 50. Необязательный параметр. По умолчанию равен 50.

Request Headers:
Status Codes:

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

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

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

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

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

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

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

Response Body:

Тело ответа содержит структуру CounteragentGroupsList:

message CounteragentGroupsList {
    repeated CounteragentGroup Groups = 1;
    required int32 TotalCount = 2;
}

  • Groups — список групп контрагентов. Каждый элемент списка представлен структурой CounteragentGroup.

  • TotalCount — количество групп контрагентов.

Получить список групп контрагентов может только сотрудник организации с разрешением CanManageCounteragents, позволяющим видеть списки контрагентов и работать с ними.

Метод не возвращает удаленные группы контрагентов.

См. также

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