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

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

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

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

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

Код параметра Описание параметра Свойство Тип Формат
documentType Тип документа Обязательное поле string Принимает значение:
СontractHardwoodDeal – декларация о сделке с древесиной
pageSize Размер страницы (количество параметров,
возвращаемых за один запрос)
Необязательное поле integer [0-9]
pageNumber Номер страницы Необязательное поле integer [0-9]
Фильтр (FilterOperation)
property Поле для фильтрации Обязательное поле string Принимает значение:
partyTypeFKey – тип контрагента;
clientCreateTimeFrom – дата ввода данных с;
clientCreateTimeTo – дата ввода данных по;
dealNumber – номер декларации;
contractNumber – номер договора (сделки), по которому приобретается
или отчуждается древесина;
receiptDateFrom – дата поступления c;
receiptDateTo – дата поступления по;
startDateFrom – дата принятия c;
startDateTo – дата принятия по;
underlyingDocumentTypeId – вид правоустанавливающего
документа;
underlyingDocumentStartDateFrom – дата правоустанавливающего документа с;
underlyingDocumentStartDateTo – дата правоустанавливающего
документа по;
declarationDataFrom – начало декларационного периода;
declarationDataTo – конец декларационного периода;
partyName – контрагент (организация);
partyFirstName – имя контрагента;
partyLastName – фамилия контрагента;
partyMidName – отчество контрагента;
inn – ИНН контрагента;
sourceSystem – источник (ГЛР, ЕГАИС, АИС);
federalDistrictId – федеральный округ;
constituentEntityId – субъект РФ;
stateAuthorityId – орган исполнительной власти;
hasHoodLotFromForestryId – лесничество;
createBy – логин пользователя, создавшего документ;
updateBy – логин пользователя, изменившего документ;
status – статус документа
value Значение для фильтрации Обязательное поле string Значение поля для фильтрации соответствует формату параметра,
описанному при формировании запросов на создание новой записи
operation Операция фильтрации Обязательное поле string Принимает значение:
Операторы сравнения:
LT - меньше (<);
LTE - меньше или равно (<=);
GT - больше (>);
GTE - больше или равно (>=);
EQ - равно (=);
NEQ - не равно (!=).

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

Выше