Формулировка проблемы: необходимо реализовать API-метод, позволяющий получить список подписей для данного документа.
Решение:
URL метода: rest/api/docflow/doc/sign_list
Тип запроса: GET.
Метод принимает следующие параметры:
documentID - UUID документа (обяз.);
locale - локаль ru/en/kz, по умолчанию ru (не
обяз.);
В случае успешного выполнения json возвращает
массив, содержащий элементы со следующими полями:
userID - UUID подписавшего сотрудника;
userName - Ф.И.О. подписавшего сотрудника;
userPosition - должность подписавшего
сотрудника;
date - стамп времени подписания в формате:
"ГГГГ-ММ-ДД ЧЧ:ММ:СС";
comment - комментарий;
actionType - тип действия, при котором
совершили подписание. Один из следующих вариантов:
SIGN_ITEM - подписано с помощью действия "Подписать";
AGREEMENT_ITEM - подписано при согласовании;
APPROVAL_ITEM - подписано при утверждении;
ACQUAINTANCE_ITEM - подписано при ознакомлении;
signType - тип подписи. Один из следующих
вариантов:
SIMPLE - обычная подпись;
ECS - электронная подпись;
Замечание:
При сбросе подписей вернуть пустой массив.
Замечание:
В случае, если документ был подписан дважды одним и тем же сотрудником, и при этом сам документ не менялся, необходимо отобразить данную подпись только один раз, вставив дату самой новой подписи.
В случае неуспешного выполнения возвращается json
с полями:
errorCode - код выполнения (число, отличное
от 0);
errorMessage - "Ошибка получения
подписей документа".
Альтернативные потоки событий:
Альтернативный поток №1. Параметр
documentID не передан, либо он пустой. Сервер
возвращает ошибку:
Не передан параметр documentID
действие не осуществляется.
Альтернативный поток №2. Передан некорректный
(несуществующий) параметр documentID. Сервер
возвращает ошибку:
Передан некорректный параметр documentID
действие не осуществляется.
Пример возвращаемого массива:
[
{
"userID": "179bda2e-6d55-4ed5-b1be-890ffad280ba",
"userName": "Калиев И.О.",
"userPosition": "Генеральный директор",
"date": "2015-05-19 11:12:13",
"comment": "",
"actionType": "SIGN_ITEM",
"signType": "SIMPLE"
},
{
"userID": "78w96q2e-6d55-4ed5-b1be-890ffad280ba",
"userName": "Захаров М.П.",
"userPosition": "Заместитель директора",
"date": "2015-05-20 10:11:12",
"comment": "OK",
"actionType": "AGREEMENT_ITEM",
"signType": "ECS"
}
]