MercuryG2B:GetForeignBusinessEntityListRequest:v3.0

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску

Общие сведения

Код операции Описание операции
... Получение списка хозяйствующих субъектов с возможностью фильтрации

Спецификация запроса

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getForeignBusinessEntityListRequest>
002 ···<bs:listOptions> bs:ListOptions [0..1] Параметры запрашиваемого списка
003 ······<bs:count>?</bs:count> xs:nonNegativeInteger [0..1]

Максимальное запрашиваемое количество объектов в списке

  • По умолчанию значение 100;
  • Максимально возможное значение 1000
004 ······<bs:offset>?</bs:offset> xs:nonNegativeInteger [0..1]

Номер элемента, по которому осуществляется смещение первого элемента списка

  • По умолчанию значение 0.
005 ···</bs:listOptions>
006 ···<dt:businessEntity> dt:BusinessEntity [0..1] Данные о хозяйствующем субъекте
007 ······<dt:name>?</dt:name> bs:String255 [0..1]

Наименование хозяйствующего субъекта

  • Указывается только для юридических лиц
  • Для физических лиц и для индивидуальных предпринимателей поле не указывается
008 ······<dt:fullName>?</dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта
009 ······<dt:fio>?</dt:fio> bs:String255 [0..1]

ФИО физического лица или индивидуального предпринимателя

  • Для юридических лиц поле не указывается
010 ······<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта
011 ······<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
012 ·········<dt:country> dt:Country [1..1]

Страна

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
013 ············<dt:code>?</dt:code> dt:Code [1..1]

Код страны

Двухбуквенный код страны, соответствующий стандарту ISO 3166-1. В качестве кода используются буквы латинского алфавита.
014 ·········<dt:country> dt:Country
015 ···</dt:businessEntity>
016 </ws:getBusinessEntityListRequest>

Спецификация ответа

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getBusinessEntityListResponse>
002 ···<dt:businessEntityList count="?" total="?" offset="?"> dt:BusinessEntityList [1..1]

Список хозяйствующих субъектов

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей.
003 ······<dt:businessEntity> dt:BusinessEntity [0..*] Хозяйствующий субъект
004 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
005 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
006 ·········<bs:active>?</bs:active> xs:boolean [1..1]

Флаг активности записи

  • true - запись активна;
  • false - запись не активна
007 ·········<bs:last>?</bs:last> xs:boolean [1..1]

Флаг, указывающий на то, что запись является последней в истории

  • true - да;
  • false - нет
008 ·········<bs:status>?</bs:status> bs:VersionStatus [1..1] Статус записи
009 ·········<bs:createDate>?</bs:createDate> xs:dateTime [1..1] Дата создания записи
010 ·········<bs:updateDate>?</bs:updateDate> xs:dateTime [1..1] Дата последнего изменения записи
011 ·········<bs:previous>?</bs:previous> bs:UUID [0..1] Идентификатор предыдущей версии записи
012 ·········<bs:next>?</bs:next> bs:UUID [0..1] Идентификатор следующей версии записи
013 ·········<dt:type>?</dt:type> dt:BusinessEntityType [1..1]

Тип хозяйствующего субъекта

  • 1 - юридическое лицо
  • 2 - физическое лицо
  • 3 - индивидуальный предприниматель
014 ·········<dt:name>?</dt:name> bs:String255 [0..1]

Наименование хозяйствующего субъекта

  • Возвращается только для юридических лиц
  • Для физических лиц и для индивидуальных предпринимателей поле не возвращается
015 ·········<dt:incorporationForm> dt:IncorporationForm [1..1] Организационно-правовая форма (ОПФ)
016 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии ОПФ
017 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование ОПФ
018 ············<dt:code>?</dt:code> bs:String255 [1..1] Код ОПФ
019 ············<dt:shortName>?</dt:shortName> bs:String255 [0..1] Краткое наименование ОПФ
020 ·········</dt:incorporationForm>
021 ·········<dt:fullName>?</dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта
022 ·········<dt:fio>?</dt:fio> bs:String255 [0..1]

ФИО физического лица или индивидуального предпринимателя

  • Для юридических лиц поле не возвращается
023 ·········<dt:inn>?</dt:inn> bs:String255 [0..1] ИНН хозяйствующего субъекта
024 ·········<dt:kpp>?</dt:kpp> bs:String255 [0..1] Код причины постановки на учет (КПП)
025 ·········<dt:ogrn>?</dt:ogrn> bs:String255 [0..1]

ОГРН или ОГРНИП

  • Для ИП ОГРНИП может быть не указано
026 ·········<dt:juridicalAddress> dt:Address [1..1] Юридический адрес
027 ··················<dt:country> dt:Country [1..1] Страна
028 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор объекта
029 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор объекта
030 ·····················<dt:name>?</dt:name> bs:String255 [1..1] Наименование
031 ··················</dt:country>
032 ··················<dt:region> dt:Region [0..1] Регион
033 ·····················<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор объекта
034 ·····················<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор объекта
035 ·····················<dt:name>?</dt:name> bs:String255 [1..1] Наименование
036 ··················</dt:region>
037 ··················<dt:district> dt:District [0..1] Район
038 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
039 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
040 ·····················<dt:name>?</dt:name> bs:String255 [1..1] Наименование
041 ··················</dt:district>
042 ·········<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
043 ·········<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
044 ·········<dt:additionalInfo>?</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация
045 ·········<dt:addressView>?</dt:addressView> bs:String255 [0..1] Строковое представление адреса
046 ·········</dt:juridicalAddress>
047 ······</dt:businessEntity>
048 ···</dt:businessEntityList>
049 </ws:getBusinessEntityListResponse>

Примеры запросов

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API MercuryG2B:Services:v3.0