Формулировка проблемы: необходимо реализовать API-метод, который должен отмечать документ как "Прочитанный", либо наоборот.
Решение: необходимо реализовать следующий метод:
URL: rest/api/docflow/doc/set_seen.
Типа: GET.
Метод принимает следующие строковые параметры:
documentID - UUID
документа (обяз.);
seen - свойство прочитанности (не обяз.):
true - отметить документ как
"Прочитанный" (по умолчанию);
false - отметить документ как
"Непрочитанный";
filterType - тип фильтра (обяз.):
ALL_USER_DOCUMENTS - все документы, к
которым пользователь имеет доступ;
USER_OWN_DOCUMENTS - все собственные
документы пользователя;
USER_RECEIVED_DOCUMENTS - все полученные
пользователем документы, в которых он не является автором;
USER_SENT_DOCUMENTS - все отправленные
пользователем документы, в которых он не является автором;
locale - локаль пользователя,
ru/en/kz (не обяз., по умолчанию
ru).
В случае успешного выполнения метода сервер вернет сообщение
Успешно.
При отметки того документа прочитанным / непрочитанным, который ранее был установлен прочитан / непрочитан, выполнение метода также считается успешным.
Альтернативные потоки событий
Альтернативный поток №1. Параметр documentID
не передан, либо он пустой. Сервер возвращает ошибку:
Не передан параметр documentID
действие не осуществляется;
Альтернативный поток №2. Передан некорректный (несуществующий)
параметр documentID. Сервер возвращает
ошибку:
Передан некорректный параметр documentID
действие не осуществляется;
Альтернативный поток №3. Параметр filterType
не передан, либо он пустой. Сервер возвращает ошибку:
Не передан параметр filterType
действие не осуществляется;
Альтернативный поток №4. Передан некорректный (несуществующий)
параметр filterType. Сервер возвращает
ошибку:
Передан некорректный параметр filterType
действие не осуществляется.