Получение данных из справочника#
Запрос GetLookupValues позволяет получить данные из справочника с параметрами, указанными в таблице.
Спецификация запроса на получение данных
| Код операции | Описание операции |
| RequestGetLookupValues | Принимает от внешних АИС запрос на получение данных из справочника, принятых в Системе, в ходе обработки которого формируется ответ и возвращается внешней АИС |
Перечень входных параметров и их формат
| Код параметра | Описание параметра | Свойство | Тип | Формат |
| lookupName | Наименование справочника в Системе (см. Нормативно-справочная информация) | Обязательное поле | string | [А-Z] [а-z] |
| pageSize | Размер страницы (количество параметров, возвращаемых за один запрос) | Необязательное поле | integer | [0-9] |
| pageNumber | Номер страницы | Необязательное поле | integer | [0-9] |
Пример сформированного запроса и ответа
Формирование запроса на получение данных из справочника#
Формирование запроса на получение данных из справочника updateReason - причины изменения статуса документа.
<soapenv:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен/">
<soapenv:Header>
<api:EgaisRequestHeader apiVersion="версия API" operationId="?">
<api:security>
<api:credentials userLogin='логин пользователя' userPassword='пароль пользователя'/>
<api:apiKey>идентификатор внешней системы</api:apiKey>
</api:security>
</api:EgaisRequestHeader>
</soapenv:Header>
<soapenv:Body>
<api:RequestGetLookupValues lookupName="updateReason" pageSize="10" pageNumber="0"/>
</soapenv:Body>
</soapenv:Envelope>
Формирование ответа на получение данных из справочника#
<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
<soap:Header>
<ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
</soap:Header>
<soap:Body>
<ns2:ResponseGetLookupValues техническая информация с атрибутами xmlns, определяющими пространства имен>
<ns2:updateReason id="3" name="Аннулирование документа"/>
<ns2:updateReason id="4" name="Возобновление действия документа после приостановления"/>
<ns2:updateReason id="1" name="Дополнительное соглашение"/>
<ns2:updateReason id="7" name="Перенайм (только для договоров аренды)"/>
<ns2:updateReason id="2" name="Приостановка действия документа"/>
<ns2:updateReason id="6" name="Прочая причина"/>
<ns2:updateReason id="5" name="Техническая ошибка"/>
</ns2:ResponseGetLookupValues>
</soap:Body>
</soap:Envelope>