MercuryG2B:GetRussianEnterpriseList:v3.0

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

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

Код операции Описание операции
... Получение списка площадок, зарегистрированных на территории РФ, с возможностью фильтрации

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

# Название XML-элемента Тип Обязат. Описание (нажмите [...] для отображения дополнительного описания)
001 <ws:getRussianEnterpriseListRequest>
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:enterprise> dt:Enterprise [0..1] Данные о площадке
007 ······<bs:uuid>?</bs:uuid> bs:UUID [0..1] Идентификатор версии записи
008 ······<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор записи
009 ······<dt:name>?</dt:name> bs:String255 [0..1] Полное наименование площадки
010 ······<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров площадок
011 ·········<dt:enterpriseNumber>?</dt:enterpriseNumber> bs:String255 [1..*] Номер площадки
012 ······</dt:numberList>
013 ······<dt:address> dt:Address [0..1] Фактический адрес расположения площадки
152 ··················<dt:country> dt:Country [1..1]

Страна

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
153 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
154 ··················</dt:country>
155 ··················<dt:region> dt:Region [1..1]

Регион

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
156 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
157 ··················</dt:region>
158 ··················<dt:district> dt:District [0..1]

Район

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
159 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
160 ··················</dt:district>
161 ··················<dt:locality> dt:Locality [0..1]

Населенный пункт

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
162 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
163 ··················</dt:locality>
164 ··················<dt:subLocality> dt:Locality [0..1]

Подчиненный населенный пункт

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
165 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
166 ··················</dt:subLocality>
167 ··················<dt:cityArea> dt:Locality [0..1]

Элемент планировочной структуры

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
168 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
169 ··················</dt:cityArea>
167 ··················<dt:street> dt:Street [0..1]

Улица

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
168 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
169 ··················</dt:street>
167 ··················<dt:landPlot> dt:LandPlot [0..1]

Земельный участок

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
168 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
169 ··················</dt:landPlot>
167 ··················<dt:building> dt:Building [0..1]

Здание (строение), сооружение

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
168 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
169 ··················</dt:building>
167 ··················<dt:apartment> dt:Apartment [0..1]

Помещение

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
168 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
169 ··················</dt:apartment>
167 ··················<dt:room> dt:Apartment [0..1]

Помещение в пределах помещения

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
168 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
169 ··················</dt:room>
167 ··················<dt:carPlace> dt:Apartment [0..1]

Машино-место

  • Обязательно должен быть указан один из идентификаторов: UUID или GUID. При указании обоих приоритет у UUID.
153 ·····················<bs:uuid>?</bs:uuid> bs:UUID [0..1] Уникальный идентификатор объекта
168 ·····················<bs:guid>?</bs:guid> bs:UUID [0..1] Глобальный идентификатор объекта
169 ··················</dt:carPlace>
053 ···············<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
054 ···············<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
055 ···············<dt:additionalInfo>?</dt:additionalInfo> bs:String255 [0..1] Дополнительная информация
036 ······</dt:address>
037 ···</dt:enterprise>
038 </ws:getRussianEnterpriseListRequest>

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

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

Список площадок

  • total - всего записей;
  • offset - смещение относительно первого элемента;
  • count - количество выводимых записей
003 ···<dt:enterprise> dt:Enterprise [1..1] Данные о площадке
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 ······<dt:name>?</dt:name> bs:String255 [1..1] Полное наименование площадки
013 ······<dt:type>?</dt:type> dt:EnterpriseType [1..1]

Тип площадки

  • 1 - предприятие;
  • 2 - рынок;
  • 3 - СББЖ;
  • 4 - судно
014 ······<dt:numberList> dt:EnterpriseNumberList [0..1] Список номеров площадок
015 ·········<dt:enterpriseNumber>?</dt:enterpriseNumber> bs:String255 [1..*] Номер площадки
016 ······</dt:numberList>
017 ······<dt:address> dt:Address [1..1] Фактический адрес расположения площадки
018 ·········<dt:country> dt:Country [1..1] Страна
019 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор записи
020 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
021 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование страны
022 ·········</dt:country>
023 ·········<dt:region> dt:Region [0..1] Регион
024 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор записи
025 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
026 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование региона
027 ·········</dt:region>
028 ·········<dt:district> dt:District [0..1] Район
029 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор записи
030 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
031 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование района
032 ·········</dt:district>
033 ·········<dt:locality> dt:Locality [0..1] Город
034 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор записи
035 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
036 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование города
037 ·········</dt:locality>
038 ·········<dt:subLocality> dt:Locality [0..1] Населённый пункт
039 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор записи
040 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
041 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование населенного пункта
042 ·········</dt:subLocality>
043 ·········<dt:street> dt:Street [0..1] Улица
044 ············<bs:uuid>?</bs:uuid> bs:UUID [1..1] Уникальный идентификатор записи
045 ············<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
046 ············<dt:name>?</dt:name> bs:String255 [1..1] Наименование улицы
047 ·········</dt:street>
048 ·········<dt:house>?</dt:house> bs:String255 [0..1] Номер дома
049 ·········<dt:building>?</dt:building> bs:String255 [0..1] Номер строения
050 ·········<dt:room>?</dt:room> bs:String255 [0..1] Номер квартиры / офиса
051 ·········<dt:postIndex>?</dt:postIndex> bs:String255 [0..1] Почтовый индекс
052 ·········<dt:postBox>?</dt:postBox> bs:String255 [0..1] Абонентский ящик
053 ·········<dt:additionalInfo>?</dt:additionalInfo> bs:NText [0..1] Дополнительная информация
054 ·········<dt:addressView>?</dt:addressView> bs:NText [0..1] Строковое представление адреса
055 ······</dt:address>
056 ······<dt:activityList count="?" total="?" offset="?"> dt:EnterpriseActivityList [0..1] Виды деятельности площадки
057 ·········<dt:activity> dt:EnterpriseActivity [1..*] Деятельность, осуществляемая площадкой
058 ············<dt:name>?</dt:name> bs:NText [1..1] Название вида деятельности
059 ·········</dt:activity>
060 ······</dt:activityList>
061 ······<dt:owner> dt:BusinessEntity [0..1] ХС-владелец площадки
062 ·········<bs:uuid>?</bs:uuid> bs:UUID [1..1] Идентификатор версии записи
063 ·········<bs:guid>?</bs:guid> bs:UUID [1..1] Глобальный идентификатор записи
064 ·········<dt:fullName>?</dt:fullName> bs:String255 [0..1] Полное наименование хозяйствующего субъекта
065 ·········<dt:fio>?</dt:fio> bs:String255 [0..1] ФИО физического лица или индивидуального предпринимателя
066 ·········<dt:juridicalAddress> dt:Address [0..1] Юридический адрес
067 ············<dt:addressView>?</dt:addressView> bs:NText [0..1] Строковое представление адреса
068 ·········</dt:juridicalAddress>
069 ······</dt:owner>
070 ······<dt:officialRegistration> dt:EnterpriseOfficialRegistration [0..*] Факт постановки на учёт в налоговом органе
071 ·········<dt:businessEntity> dt:BusinessEntity [1..1] Хозяйствующий субъект, поставивший площадку на учёт в налоговом органе
072 ············<dt:inn>?</dt:inn> bs:String255 [1..1] ИНН хозяйствующего субъекта
073 ·········</dt:businessEntity>
074 ·········<dt:kpp>?</dt:kpp> bs:String255 [1..1] Код причины постановки на учёт (КПП)
075 ······</dt:officialRegistration>
076 ······<dt:registryStatus>?</dt:registryStatus> dt:EnterpriseStatus [1..1]

Статус площадки в реестре ИС Цербер

  • UNVERIFIED - Не подтверджен (не в реестре)
  • VERIFIED - Подтвержден (включен в реестр)
  • CANCELED - Исключен из реестра
  • DELETED - Удален
077 ···</dt:enterprise>
078 ···</dt:enterpriseList>
079 </ws:getRussianEnterpriseListResponse>

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

TODO

См. также

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

Источник — http://help.vetrf.ru/index.php?title=MercuryG2B:GetRussianEnterpriseList:v3.0&oldid=44692