Приложение 2 Описание видов сведений для получения значений справочника
Для получения значений справочника на стороне ведомства могут быть реализованы следующие виды сведений:
listRefAttributes – получение списка атрибутов заданного справочника
на вход принимает параметры: refName – код (мнемоника) справочника в ИС ФОИВ.
возвращает список атрибутов, для каждого из которых указано:
name – Код (мнемоника) справочника (string, обязательно);
title - Наименование атрибута (string, обязательно);
type - STRING / LONG / DECIMAL / DATETIME / BOOLEAN (перечисление, обязательно);
refName - Код справочника (если атрибут - это ссылка) (string, опционально);
multiple - признак «Множественный» (boolean, обязательно);
allowFiltering - признак «Можно фильтровать по атрибуту» (boolean, обязательно).
listRefItems – получение значений (дерева элеметов) заданного справочника
на вход принимает параметры:
refName – код (мнемоника) справочника в ИС ФОИВ (string, обязательно);
parentRefItemValue - Код родительского элемента (string, опционально);
treeFiltering - ONELEVEL / SUBTREE (перечисление, опционально);
selectAttributes - Список атрибутов, которые нужно возвращать (string, обязательно);
filter - Предикат для фильтрации элементов справочника (опционально);
orderBy - Задает порядок сортировки элементов (опционально);
pageNum - Номер необходимой страницы (0, чтобы получить все элементы) (Integer, опционально);
pageSize - Размер страницы (0, чтобы получить все элементы) (Integer, опционально).
возвращает список атрибутов, для каждого из которых указано:
value – Код (мнемоника) элемента справочника (string, обязательно);
parentValue - Код родительского элемента (string, опционально);
title - Название элемента справочника (string, обязательно);
isLeaf - Признак «Нет дочерних элементов» (для иерархических справочников) (boolean, обязательно);
children - Предикат для фильтрации элементов справочника (опционально, может быть множественным);
attributes - Список значений дополнительных атрибутов элемента справочника (опционально, может быть множественным).
Примеры запросов и ответов
Пример блока MessagePrimaryContent запроса к listRefAttributes приведен ниже:
Пример блока MessagePrimaryContent ответа от listRefAttributes приведен ниже:
0
operation completed
fias
Код ФИАС
STRING
false
true
title
STRING
false
true
|
Пример блока MessagePrimaryContent запроса к listRefItems приведен ниже:
ETS
0107
SUBTREE
kind_num
1
50
|
Пример блока MessagePrimaryContent ответа от listRefItems и фрагмент справочника, которому он соответствует, приведены ниже:
Таблица 5 Фрагмент справочника из примера ответа от listRefItems
Название справочника
|
Код родительского значения
|
Код значения справочника
|
Название значения справочника
|
ETS
|
0107
|
010701
|
береговая станция МПС
|
010701
|
01070101
|
РЭС для радиосвязи в полосе 146 - 174 МГц, в том числе портовая станция и станция службы движения судов
|
010701
|
01070102
|
РЭС для радиосвязи в полосе 9 кГц - 30 МГц, в том числе портовая станция и станция службы движения судов
|
0107
|
010702
|
судовая станция МПС (РЭС, установленные на судах морского или смешанного река-море плавания)
|
010702
|
01070201
|
РЭС для радиосвязи в полосе 146 - 174 МГц
|
010702
|
01070202
|
РЭС для радиосвязи в полосе 9 кГц - 30 МГц
|
В качестве дополнительного атрибута для каждого корневого значения справочника передается его родительский код.
40
010701
береговая станция МПС
false
01070101
РЭС для радиосвязи в полосе 146 - 174 МГц, в том числе портовая станция и станция службы движения судов
true
01070102
РЭС для радиосвязи в полосе 9 кГц - 30 МГц, в том числе портовая станция и станция службы движения судов
true
parentrefcode
STRING
0107
010702
судовая станция МПС (РЭС, установленные на судах морского или смешанного река-море плавания)
false
01070201
РЭС для радиосвязи в полосе 146 - 174 МГц
true
01070202
РЭС для радиосвязи в полосе 9 кГц - 30 МГц
true
parentrefcode
STRING
0107
|
|
