Формулировка проблемы: необходимо реализовать API-метод, который должен возвращать маршруты, доступные авторизованному пользователю.
Решение: необходимо реализовать следующий метод:
URL: rest/api/docflow/doc/routes.
Типа: GET.
Метод принимает следующие необязательные строковые параметры:
search - строка поиска (поиск производится
только по наименованию маршрутов);
bookmarks - признак избранности:
true - отображать только избранные
маршруты;
false - отображать все маршруты (по
умолчанию);
locale - локаль пользователя,
ru/en/kz (по умолчанию
ru).
В случае успешного выполнения возвращает json c
полями:
routeID - uuid маршрута;
routeName - наименование маршрута;
authorID - uuid автора
маршрута;
authorName - имя автора маршрута;
isBookmark - является ли маршрут
"Избранным".
В случае неуспешного выполнения возвращается json
с полями:
errorCode - код выполнения (число, отличное
от 0);
errorMessage - сообщение об ошибке.
При этом, язык текста сообщения об ошибке должен зависеть от выбранной локали.
Пример возвращаемых массивов
успешное выполнение:
[
{
"routeID": "c4ddd6b1-ade2-4ee2-ace5-aaec6a81d02a",
"routeName": "Анализ бухгалтерского баланса",
"authorID": "ee71a4c6-888a-4f04-86de-44ab394f5749",
"authorName": "Слепаков И.И.",
"isBookmark": "false"
},
{
"routeID": "22a48f88-199a-4398-8eb6-15ba8ef35deb",
"routeName": "Анализ бухгалтерского баланса №2",
"authorID": "ee71a4c6-888a-4f04-86de-44ab394f5749",
"authorName": "Слепаков И.И.",
"isBookmark": "true"
}
]
неуспешное выполнение:
{"errorCode" : "13", "errorMessage" : "Ошибка исполнения"}