24. Метод "Получить справочную информацию по группе объектов" (getRefItemsList)

Параметр

Тип

Обязательность

Комментарий

refName

String

Y

Мнемоника запрашиваемого справочника

parentRefItemValue

String

N

Код родительского элемента (для иерархических справочников)

treeFiltering

Enum

Y

Параметр предназначен для управления размером выдачи для иерархических справочников. Значение ONELEVEL выдает список значений только на текущем уровне справочника. Значение SUBTREE выдает список значений на текущем и нижестоящих уровнях справочника

selectAttributes

Array [String]

N

Список атрибутов, которые нужно возвращать

filter

Predicate

N

Предикат для фильтрации элементов справочника

orderBy

Array [String]

N

Задает порядок сортировки элементов (указывается список атрибутов, в порядке следования которых выполнять сортировку)

pageNum

Integer

Y

Номер необходимой страницы (0, чтобы получить все элементы)

pageSize

Integer

Y

Размер страницы (0, чтобы получить все элементы)

version

String

N

Если версия справочника, переданная в данном параметре ниже, чем актуальная на стороне сервера, то в ответе вернется перечень произошедших изменений в справочнике.

Если поле "Version" запроса совпадает с текущей версией справочника на стороне информационной системы органа или организации, возвращается код ошибки "Ваш справочник имеет актуальную версию".

Поле "version" может не указываться, если орган или организация не поддерживает версионирование данных в справочнике

Параметр

Тип

Обязательность

Комментарий

totalItems

Integer

Y

Общее количество найденных элементов

items

Array [RefItem]

N

Список запрошенных элементов. Передаваемые атрибуты:

a. "latitude" - широта

b. "longitude" - долгота

При передаче справочника органа или организации, необходимо передавать атрибуты "a" и "b" для корректного отображения на карте местоположения органа или организации, куда может обратиться заявитель.

Координаты передаются с использованием модели Земли WGS-84 в десятичном формате.

При передаче справочника органа или организации необходимо передавать расписание их работы в следующих атрибутах:

а) "TimetableComment" - общий комментарий к расписанию (plain text)

б) "XXXIsWorking" - признак работы в данный день недели: "true" или "false"

в) "XXXStart" - время начала работы, например "9:00"

г) "XXXEnd" - время окончания работы, например "17:00"

д) "XXXHasDinner" - признак наличия обеда

е) "XXXDinnerStart" - время начала обеда, например "13:00"

ж) "XXXDinnerEnd" - время окончания обеда, например "14:00"

где вместо XXX подставляется аббревиатура дня недели из списка:

"mon" - понедельник

"tue" - вторник

"wed" - среда

"thu" - четверг

"fri" - пятница

"sat" - суббота

"sun" - воскресенье

version

String

N

Текущая версия справочника

error

Error

N

В случае возникновения ошибки в ответе возвращается структура "Error"