Помощник по сервису интеграции

Получение сведений о документе по заданным параметрам фильтрации#

Запрос GetDocumentsByFilter позволяет получить сведения о документе по заданным параметрам фильтрации, указанным в таблице.

Спецификация запроса на получение данных

Код операции Описание операции
RequestGetDocumentsByFilter Принимает от внешних АИС запрос на получение данных по заданным параметрам фильтрации, в ходе обработки которого формируется ответ и возвращается внешней АИС

Перечень входных параметров и их формат

Код параметра Описание параметра Свойство Тип Формат
documentType Типа документа Обязательное поле string Принимает значение:
contractLease – договор аренды ЛУ;
contractRight - право пользования;
contractForestWorks – государственный контракт или задание;
contractPlantsSale – договор купли-продажи;
contractForestDeclaration – лесная декларация;
contractReport – отчёт об использовании лесов;
contractHardwoodDeal – сделка с древесиной;
cuttingPlot - выдел;
contractPlotTaxation – таксационное описание выдела;
contractForestManagementRegulation – лесохозяйственный регламент;
cuttingArea - лесосека;
woodSites – лесной участок;
contractForestryTaxation – таксационное описание лесничества;
contractReforestationReport – отчет о воспроизводстве лесов;
contractProtectionReport – отчет об охране лесов;
contractSecurityReport – отчет о защите лесов
pageSize Размер страницы (количество параметров, возвращаемых за один запрос) Необязательное поле integer [0-9]
pageNumber Номер страницы Необязательное поле integer [0-9]
Фильтр (FilterOperation)
property Поле для фильтрации Обязательное поле string Параметр для фильтрации для каждого реестра описан детально в соответствующем разделе
value Значение для фильтрации Обязательное поле string Значение поля для фильтрации соответствует формату параметра, описанному при формировании запросов на создание новой записи
operation Операция фильтрации Обязательное поле string Принимает значение:
Операторы сравнения:
LT - меньше (<);
LTE - меньше или равно (<=);
GT - больше (>);
GTE - больше или равно (>=);
EQ - равно (=);
NEQ - не равно (!=).

Логические операторы:
LIKE - указанная символьная строка совпадает с заданным шаблоном;
ILIKE - указанная символьная строка не совпадает с заданным шаблоном;
IN - указанное значение совпадает с одним из значений, содержащихся в списке;
NIN - указанное значение не соответствуют списку значений;
IS_NULL - отсутствие значения;
IS_NOT_NULL - наличие значения.

Примеры сформированных запросов и ответов на получение сведений о документе по заданным параметрам фильтрации приведены в соответствующих разделах (см. "Интеграция внешних АИС органов исполнительной власти" и "Интеграция внешних АИС лесопользователей").

Выше