GetRussianEnterpriseList: различия между версиями

Версия 10:47, 25 ноября 2016

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

Операция GetRussianEnterpriseList предназначена для получения списка предприятий, зарегистрированных на территории Российской Федерации. Выводятся актуальные записи (active=true, last=true). Операция поддерживает фильтрацию по полям предприятия и постраничный вывод.

Используемые пространства имён и типы

xs (http://www.w3.org/2001/XMLSchema)

ent (http://api.vetrf.ru/schema/cdm/cerberus/enterprise)
- ent:Enterprise
- ent:EnterpriseList

bs (http://api.vetrf.ru/schema/cdm/base)
- bs:UUID
- bs:ListOptions

Входные данные

параметры выводимого списка;
поля предприятия, по которым список фильтруется.

Выходные данные

список российских предприятий.

Данные запроса

Объект getRussianEnterpriseListRequest

Корневой объект запроса. Содержит информацию о параметрах запрашиваемого списка и поля фильтрации предприятия.

Поле	Описание	Тип данных	Обязательность
listOptions	Параметры выводимого списка.	bs:ListOptions	0..1
enterprise	Объект, описывающий предприятие. Содержит поля, по которым доступна фильтрация.	ent:Enterprise	0..*

Объект ..Request/listOptions

Объект содержит параметры выводимого списка.

Поле	Описание	Тип данных	Обязательность
count	Количество значений в списке По умолчанию значение равно 100; Максимально допустимое значение равно 1000.	xs:nonNegativeInteger	0..1
offset	Смещение в списке относительно начала.	xs:nonNegativeInteger	0..1

Объект ..Request/enterprise

Объект, описывающий предприятие. Здесь приведены только те его поля, по которым допустима фильтрация в методе. Полный список полей можно посмотреть в описании типа Enterprise.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи предприятия в реестре Россельхознадзора.	bs:UUID	0..1
GUID	Уникальный глобальный идентификатор в реестре Россельхознадзора.	bs:UUID	0..1
name	Название предприятия.	bs:String255	0..1
address	Адрес предприятия.	ikar:Address	0..1

Объект ..Request/enterprise/address

Объект содержит описание адреса предприятия. Описаны только поля, по которым производится фильтрация. Полный набор полей можно посмотреть в описании типа Address.

Поле	Описание	Тип данных	Обязательность
region	Регион Российской Федерации.	ikar:Region	0..1
district	Район региона Российской Федерации. При поиске по району указывать регион не обязательно.	ikar:District	0..1
locality	Населённый пункт регионального подчинения. По населённым пунктам районного подчинения поиск не осуществляется; При поиске обязательно также указывать регион.	ikar:Locality	0..1

Объект ..Request/enterprise/address/region

Объект содержит данные региона. Фильтрация предприятий в операции осуществляется только при использовании GUID и UUID. Остальные поля описаны в типе данных Region.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи региона.	bs:UUID	1 - обязательно указать один из идентификаторов. При указании обоих приоритет будет за UUID.
GUID	Глобальный идентификатор региона.	bs:UUID

Объект ..Request/enterprise/address/district

Объект содержит данные района. Фильтрация предприятий в операции осуществляется только при использовании GUID и UUID. Остальные поля описаны в типе данных District.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи района.	bs:UUID	1 - обязательно указать один из идентификаторов. При указании обоих приоритет будет за UUID.
GUID	Глобальный идентификатор района.	bs:UUID

Объект ..Request/enterprise/address/locality

Объект содержит данные населённого пункта. Фильтрация предприятий в операции осуществляется только при использовании GUID и UUID. Остальные поля описаны в типе данных Locality.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи населённого пункта.	bs:UUID	1 - обязательно указать один из идентификаторов. При указании обоих приоритет будет за UUID.
GUID	Глобальный идентификатор населённого пункта.	bs:UUID

Данные ответа

Объект getRussianEnterpriseListResponse

Корневой объект ответа. Содержит информацию о списке возвращаемых предприятий.

Поле	Описание	Тип данных	Обязательность
enterpriseList	Объект описывает список возвращаемых предприятий.	ent:EnterpriseList	1

Объект ..Response/enterpriseList

Объект содержит список предприятий, возвращаемых в результате выполнения операции.

Поле	Описание	Тип данных	Обязательность
enterprise	Объект, описывающий предприятие.	ent:Enterprise	0..1

Объект ..Response/enterpriseList/enterprise

Объект содержит сведения о предприятии.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи предприятия.	bs:UUID	1
GUID	Глобальный идентификатор предприятия в реестре Россельхознадзора.	bs:UUID	1
active	Флаг, указывающий на то, активно ли предприятие.	xs:boolean	1
last	Флаг, указывающий на то, последняя ли запись.	xs:boolean	1
status	Статус версии записи.	bs:VersionStatus	1
createDate	Дата создания записи предприятия в реестре Россельхознадзора.	xs:dateTime	1
updateDate	Дата последнего обновления записи предприятия в реестре Россельхознадзора.	xs:dateTime	1
previous	Предыдущая версия записи предприятия в реестре Россельхощнадзора.	bs:UUID	0..1
name	Название предприятия.	bs:String255	1
type	Тип предприятия согласно классификации в Меркурии: 1 - предприятие; 2 - рынок; 3 - СББЖ; 4 - судно.	ent:EnterpriseType	1
address	Фактический адрес предприятия.	ikar:Address	1
activityList	Список видов деятельности предприятия.	ent:EnterpriseActivtyList	1

Объект ..Response/enterpriseList/enterprise/address

Объект, описывающий содержимое адреса предприятия.

Поле	Описание	Тип данных	Обязательность
country	Страна, где находится предприятие.	ikar:Country	1
region	Регион страны. В данной операции, это один из регионов России или город федерального значения.	ikar:Region	1
district	Район региона.	ikar:District	1
locality	Населённый пункт.	ikar:Locality	1
sublocality	Населённый пункт, подчинённый населённому пункту.	ikar:Locality	1
street	Улица.	ikar:Street	1
house	Дом.	bs:String255	0..1
building	Строение.	bs:String255	0..1
room	Помещение (офис, квартира и т.п.).	bs:String255	0..1
postIndex	Почтовый индекс.	bs:String255	0..1
postBox	Абонентский ящик.	bs:String255	0..1
addressView	Текстовое представление адреса.	bs:String255	1

Объект ..Response/enterpriseList/enterprise/address/country

Объект, содержащий данные страны.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи в реестре Россельхознадзора.	bs:UUID	1
GUID	Глобальный идентификатор страны в реестре Россельхознадзора.	bs:UUID	1
name	Название страны.	bs:String255	1

Объект ..Response/enterpriseList/enterprise/address/region

Объект, содержащий данные о регионе или городе федерального значения.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи в реестре Россельхознадзора.	bs:UUID	1
GUID	Глобальный идентификатор региона или города федерального значения в реестре Россельхознадзора.	bs:UUID	1
name	Название региона или города федерального значения.	bs:String255	1

Объект ..Response/enterpriseList/enterprise/address/district

Объект, содержащий данные о районе региона.

Поле	Описание	Тип данных	Обязательность
UUID	Уникальный идентификатор версии записи в реестре Россельхознадзора.	bs:UUID	0..1
GUID	Глобальный идентификатор района в реестре Россельхознадзора.	bs:UUID	0..1
name	Название района.	bs:String255	0..1

Объект ..Response/enterpriseList/enterprise/address/locality

Объект, содержащий данные о населённом пункте региона.

Поле	Описание	Тип данных	Обязательность
GUID	Глобальный идентификатор населённого пункта в реестре Россельхознадзора.	bs:UUID	0..1
name	Название населённого пункта.	bs:String255	0..1

Объект ..Response/enterpriseList/enterprise/address/sublocality

Объект, содержащий данные о населённом пункте, подчинённом другому населённому пункту.

Поле	Описание	Тип данных	Обязательность
GUID	Глобальный идентификатор населённого пункта в реестре Россельхознадзора.	bs:UUID	0..1
name	Название населённого пункта.	bs:String255	0..1

Объект ..Response/enterpriseList/enterprise/address/street

Объект, содержащий данные об улице.

Поле	Описание	Тип данных	Обязательность
GUID	Глобальный идентификатор цлицы в реестре Россельхознадзора.	bs:UUID	0..1
name	Название улицы.	bs:String255	0..1

@@ Строка 202: / Строка 202: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| '''country''' || Страна, где находится предприятие. || [[Country|ikar:Country]] || 1
+| [[#Объект ..Response/enterpriseList/enterprise/address/country|'''country''']] || Страна, где находится предприятие. || [[Country|ikar:Country]] || 1
 |-
-| '''region''' || Регион страны. В данной операции, это один из регионов России или город федерального значения. || [[Region|ikar:Region]] || 1
+| [[#Объект ..Response/enterpriseList/enterprise/address/region|'''region''']] || Регион страны. В данной операции, это один из регионов России или город федерального значения. || [[Region|ikar:Region]] || 1
 |-
-| '''district''' || Район региона. || [[District|ikar:District]] || 1
+| [[#Объект ..Response/enterpriseList/enterprise/address/district|'''district''']] || Район региона. || [[District|ikar:District]] || 1
 |-
-| '''locality''' || Населённый пункт. || [[Locality|ikar:Locality]] || 1
+| [[#Объект ..Response/enterpriseList/enterprise/address/locality|'''locality''']] || Населённый пункт. || [[Locality|ikar:Locality]] || 1
 |-
-| '''sublocality''' || Населённый пункт, подчинённый населённому пункту. || [[Locality|ikar:Locality]] || 1
+| [[#Объект ..Response/enterpriseList/enterprise/address/sublocality|'''sublocality''']] || Населённый пункт, подчинённый населённому пункту. || [[Locality|ikar:Locality]] || 1
 |-
-| '''street''' || Улица. || [[Street|ikar:Street]] || 1
+| [[#Объект ..Response/enterpriseList/enterprise/address/street|'''street''']] || Улица. || [[Street|ikar:Street]] || 1
 |-
-| '''house''' || Дом || [[String255|bs:String255]] || 0..1
+| '''house''' || Дом. || [[String255|bs:String255]] || 0..1
 |-
-| '''building''' || Строение || [[String255|bs:String255]] || 0..1
+| '''building''' || Строение. || [[String255|bs:String255]] || 0..1
 |-
-| '''room''' || Помещение (офис, квартира и т.п.) || [[String255|bs:String255]] || 0..1
+| '''room''' || Помещение (офис, квартира и т.п.). || [[String255|bs:String255]] || 0..1
 |-
-| '''postIndex''' || Почтовый индекс || [[String255|bs:String255]] || 0..1
+| '''postIndex''' || Почтовый индекс. || [[String255|bs:String255]] || 0..1
 |-
-| '''postBox''' || Абонентский ящик || [[String255|bs:String255]] || 0..1
+| '''postBox''' || Абонентский ящик. || [[String255|bs:String255]] || 0..1
 |-
 | '''addressView''' || Текстовое представление адреса. || [[String255|bs:String255]] || 1