Herriot:GetRussianEnterpriseList:v1.0

Материал из Справочная система Россельхознадзора
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к навигации Перейти к поиску

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

Код Описание операции
ES.HRT.3.3 Получение списка площадок РФ

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

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

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

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

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

TODO

См. также

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

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