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

Версия 14:58, 28 октября 2016

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

Метод позволяет получить список ХС. В список попадают только актуальные записи (active = true). Метод поддерживает возможность постраничного вывода и фильтрации по шаблону.

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

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

ent (http://api.vetrf.ru/schema/cdm/cerberus/enterprise)
- ent:BusinessEntityList
- ent:BusinessEntity

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

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

Объект getBusinessEntityListRequest

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

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

Объект ..Request/businessEntity

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

Поле	Описание	Тип	Обязательность
type	Тип предприятия. 1 - юридическое лицо 2 - физическое лицо 3 - индивидуальный предприниматель	ent:BusinessEntityType	0..1
name	Название предприятия.	bs:String255	0..1
incorporationForm	Организационно-правовая форма в соответствии с общероссийским классификатором	ent:IncorporationForm	0..1
fullName	Полное наименование хоз.субъекта с указанием ОПФ так, как оно значится в ЕГРЮЛ/ЕГРИП.	bs:String255	0..1
fio	ФИО. Обязательно при создании ИП	bs:String255	0..1
inn	ИНН субъекта.	bs:String255	0..1
ogrn	ОГРН субъекта.	bs:String255	0..1
juridicalAddress	Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица..	ikar:Address	0..1

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

Объект getBusinessEntityListResponse

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

Поле	Описание	Тип	Обязательность
'businessEntityList'	Объект, описывающий список хозсубъектов	ent:BusinessEntityList	1

Объект ..Response/businessEntityList

Объект, описывающий список хозяйствующих субъектов

Поле	Описание	Тип	Обязательность
businessEntity	Объект, описывающий хозсубъект	ent:BusinessEntity	1

@@ Строка 63: / Строка 63: @@
 |-
 | '''juridicalAddress''' || Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица.. || [[Address|ikar:Address]] || 0..1
+|}
+==Данные ответа==
+===Объект getBusinessEntityListResponse===
+Корневой объект ответа. Содержит список запрашиваемых хозяйствующих субъектов.
+{| class="wikitable"
+|-
+! Поле !! Описание !! Тип !! Обязательность
+|-
+| '[[#Объект ..Response/businessEntity|''businessEntityList''']] || Объект, описывающий список хозсубъектов || [[BusinessEntityList|ent:BusinessEntityList]] || 1
 |}
+===Объект [[#Объект getBusinessEntityResponse|..Response]]/businessEntityList===
+Объект, описывающий список хозяйствующих субъектов
+{| class="wikitable"
+|-
+! Поле !! Описание !! Тип !! Обязательность
+|-
+| [[#Объект ..Response/businessEntityList/businessEntity|'''businessEntity''']] || Объект, описывающий хозсубъект || [[BusinessEntity|ent:BusinessEntity]] || 1
+|}
+===Объект [[#Объект getBusinessEntityResponse|..Response]]/[[#Объект ..Response/businessEntityList|businessEntityList]]/businessEntity===