GetSubscriptions

Примечание

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

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

GET /GetSubscriptions

Query Parameters:

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

• userId – идентификатор пользователя.

Request Headers:

• Authorization – данные, необходимые для авторизации.

Status Codes:

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

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

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

• 402 Payment Required – у указанного ящика закончилась подписка на API.

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

• 404 Not Found – в указанном ящике нет пользователя с указанным идентификатором.

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

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

Response Body:

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

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

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

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

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

{
    "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 — возвращает список сотрудников указанной организации

• GetMyEmployee — возвращает данные сотрудника организации, от имени которого вызывается метод

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

• UpdateEmployee — изменяет данные сотрудника организации

• UpdateSubscriptions — изменяет подписки сотрудника организации на почтовые уведомления