Получение данных из справочника контрагентов#
Запрос GetPartyValues позволяет получить данные из справочника контрагентов с параметрами, указанными в таблице.
Спецификация запроса на получение данных
Код операции | Описание операции |
RequestGetPartyValues | Принимает от внешних АИС запрос на получение данных о контрагентах, в ходе обработки которого формируется ответ и возвращается внешней АИС |
Перечень входных параметров и их формат
Код параметра | Описание параметра | Свойство | Тип | Формат | |
pageSize | Размер страницы (количество параметров, возвращаемых за один запрос) | Необязательное поле | integer | [0-9] | |
pageNumber | Номер страницы | Необязательное поле | integer | [0-9] | |
Фильтр | |||||
property | Поле для фильтрации | Обязательное поле | string | Принимает значение: personDocSeries – серия паспорта; personDocNum - номер паспорта; personFirstName – имя; personLastName – фамилия; personMidName – отчество. |
|
value | Значение для фильтрации | Обязательное поле | string | personDocSeries : [0-9] {4}; personDocNum : [0-9] {6}; personFirstName : [0-9] [A-Я] [а-я]; personLastName : [0-9] [A-Я] [а-я]; personMidName : [0-9] [A-Я] [а-я]. |
|
operation | Операция фильтрации | Обязательное поле | string | Принимает значение: Операторы сравнения: LT - меньше (<); LTE - меньше или равно (<=); GT - больше (>); GTE - больше или равно (>=); EQ - равно (=); NEQ - не равно (!=). Логические операторы: LIKE - указанная символьная строка совпадает с заданным шаблоном; ILIKE - указанная символьная строка не совпадает с заданным шаблоном; IN - указанное значение совпадает с одним из значений, содержащихся в списке; NIN - указанное значение не соответствуют списку значений; IS_NULL - отсутствие значения; IS_NOT_NULL - наличие значения. |
Пример сформированного запроса и ответа
Формирование запроса на получение данных из справочника контрагентов#
Формирование запроса на получение данных из справочника контрагентов по параметру personLastName - фамилия.
<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:RequestGetPartyValues pageSize="10" pageNumber="0"> <!--Optional:--> <api:filter> <!--0 to 100 repetitions:--> <api:item> <fil:property>personLastName</fil:property> <!--1 or more repetitions:--> <fil:value>Тестов</fil:value> <fil:operation>EQ</fil:operation> </api:item> </api:filter> </api:RequestGetPartyValues> </soapenv:Body> </soapenv:Envelope>
Формирование ответа на получение данных из справочника контрагентов#
<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен> <soap:Header> <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен> </soap:Header> <soap:Body> <ns2:ResponseGetPartyValues техническая информация с атрибутами xmlns, определяющими пространства имен> <ns2:party id="G_13504866" createdBy="" updatedBy="" sourceKey=""> <partyType>1</partyType> <inn>370250382877</inn> <ogrn/> <partyName/> <personFirstName>Тест</personFirstName> <personLastName>Тестов</personLastName> <personMidName>Тестович</personMidName> <personDocTypeId>0</personDocTypeId> <personDocSeries>2516</personDocSeries> <personDocNum></personDocNum> <physicalAddress>г. Тест, тестовой области,</physicalAddress> <goldenRecordId>G_13504866</goldenRecordId> <legalFormId>80</legalFormId> </ns2:party> </ns2:ResponseGetPartyValues> </soap:Body> </soap:Envelope>