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

GetSubscriptions

к сведению

Вызов метода доступен только администраторам организации и пользователю, для которого запрашиваются подписки.

Возвращает информацию о подписках сотрудника организации на почтовые уведомления.

GET /GetSubscriptions

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

  • boxId — идентификатор ящика организации в формате GUID.
  • userId — идентификатор пользователя.

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

Коды ответа

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

Тело ответа

Тело ответа содержит информацию о подписках сотрудника организации на почтовые уведомления, представленную структурой EmployeeSubscriptions.

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

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

GET /GetSubscriptions?boxId={{boxId}}&userId={{userId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json

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

{
"Subscriptions": [
{
"Id": "News",
"IsSubscribed": true
},
{
"Id": "NewIncomingDocuments",
"IsSubscribed": true
},
{
"Id": "CounteragentInvitation",
"IsSubscribed": false
},
{
"Id": "CounteragentInvitationResponses",
"IsSubscribed": false
},
{
"Id": "CounteragentSignatures",
"IsSubscribed": false
},
{
"Id": "CounteragentSignatureDenials",
"IsSubscribed": false
},
{
"Id": "ResolutionRequests",
"IsSubscribed": false
},
{
"Id": "ResolutionResults",
"IsSubscribed": true
},
{
"Id": "EmployeeRequests",
"IsSubscribed": false
},
{
"Id": "ChatMessages",
"IsSubscribed": false
}
]
}

См. также

Инструкции:

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

  • CreateEmployee — добавляет в организацию сотрудника с указанными реквизитами (доступно только администраторам ящика)
  • DeleteEmployee — удаляет сотрудника организации (доступно только администраторам ящика)
  • GetEmployee — возвращает данные сотрудника организации по указанному идентификатору (доступно только администраторам ящика)
  • GetEmployees — возвращает список сотрудников указанной организации (доступно только администраторам ящика)
  • GetEmployeesByExternalId — возвращает список сотрудников организации по идентификатору учетной записи в системе SSO-провайдера (доступно только администраторам ящика)
  • GetMyEmployee — возвращает данные сотрудника организации, от имени которого вызывается метод
  • GetSubscriptions — возвращает информацию о подписках сотрудника организации на почтовые уведомления
  • UpdateEmployee — изменяет данные сотрудника организации (доступно только администраторам ящика)
  • UpdateSubscriptions — изменяет подписки сотрудника организации на почтовые уведомления

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

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

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