Формулировка проблемы: для реализации нового модуля «Документы» в мобильном клиенте требуется реализовать API для получения списка дочерних документов.
Решение: необходимо реализовать новый метод API, который должен позволять получать список документов.
URL
метода:
rest/api/docflow/doc/child_documents
. Типа
запроса: GET
.
Метод принимает следующие параметры:
documentID
- UUID родительского документа
(обяз.);
locale
- локаль пользователя,
ru/en/kz
(не обяз., по умолчанию
ru
).
Альтернативные потоки событий:
при вводе невалидного параметра documentID
,
система выдает ошибку «Введен невалидный параметр
documentID
», список не возвращается;
при отсутствии параметра documentID
, система
выдает ошибку «Не введен параметр
documentID
», список не возвращается;
в случае неуспешного выполнения метода сервер вернет сообщение «Ошибка получения списка дочерних документов».
Метод возвращает тот же json
, что и в методе
documents
, описанном в задаче
61.API27.