ЕСОЗ - публічна документація
(GraphQL) Search Rule engine set by params_UA
Ціль
Даний веб-сервіс (WS) дозволяє здійснити пошук механізмів правил в Адміністративній панелі з використанням пошукових параметрів.
Основні положення
Це метод graphQl, який використовуюється тільки в Адміністративній панелі
Тільки автентифіковані та авторизовані співробітники НСЗУ з відповідним скоупом можуть здійснювати пошук механізмів правил.
Специфікація
(graphql - RuleEngineSetQuery
TBD)
Авторизація
Перевірити валідність токену доступу
в разі помилки - повернути код 401 (“Invalid access token”), якщо валідація неуспішна
Перевірити, що токен дійсний
в разі помилки - повернути код 401 (“Invalid access token”)
Перевірити скоупи користувача на можливість виконання даної дії (scope = 'rule_engine_set:details')
повернути 403 (“Your scope does not allow to access this resource. Missing allowances: rule_engine_set:details”) в разі невалідних скоупів
Перевірити юридичну особу
Отримати client_id з токену
Перевірити скоупи користувача на можливість виконання даної дії (scope = 'rule_engine_set:details')
в разі помилки - повернути 403 (“Your scope does not allow to access this resource. Missing allowances: rule_engine_set:details”)
Перевірити статус юридичної особи (status = ACTIVE)
в разі помилки - повернути 409 ('client_id refers to legal entity that is not active')
Пошукові параметри
Пошук здійснюється по декільком параметрам у відповідності до логічного правила “І“.
id. Пошук по rule_engine_sets.id (used to get rule engine sets details)
name. Пошук по rule_engine_sets.name
is_active. Пошук по rule_engine_sets.is_active
code.system. Пошук по rule_engine_sets.code.system
code.value. Пошук по rule_engine_sets.code.value
Сервісна логіка
Відобразити відповідь у відповідності до пошукових параметрів.
ЕСОЗ - публічна документація