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

Версия 09:04, 31 октября 2016

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

Метод позволяет получить последнюю в истории запись ХС по её глобальному идентификатору. То есть критериями запроса являются поля guid и last (guid должен совпадать, last = true).

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

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

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

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

ikar (http://api.vetrf.ru/schema/cdm/ikar)
- ikar:Address

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

Объект getBusinessEntityByGuidRequest

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

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

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

Объект getBusinessEntityChangesListResponse

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

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

Объект ..Response/businessEntityList

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

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

Объект ..Response/businessEntityList/businessEntity

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

Поле	Описание	Тип	Обязательность
UUID	Идентификатор версии записи хозяйствующего субъекта (юридического лица).	bs:UUID	1
GUID	Глобальный идентификатор хозяйствующего субъекта в реестре РСХН.	bs:UUID	1
active	Флаг, показывающий активна ли запись.	xs:boolean	1
last	Флаг, показывающий последняя ли версия записи.	xs:boolean	1
createDate	Дата создания записи.	xs:dateTime	1
updateDate	Дата обновления записи. Если данные объекта не менялись, то дата обновления совпадает с датой создания.	xs:dateTime	1
previous	Ссылка на индентификатор предыдущей версии записи	bs:UUID	0..1
next	Сссылка на идентификатор следующей версии записи	bs:UUID	0..1
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
passport	Номер паспорта.	bs:String255	0..1
inn	ИНН субъекта.	bs:String255	0..1
kpp	КПП субъекта.	bs:String255	0..1
ogrn	ОГРН субъекта.	bs:String255	0..1
juridicalAddress	Юридический адрес. Обязательным является указание идентификатора страны, региона и текстового представления адреса. Желательным является указание адреса в виде идентификаторов компонентов адреса: страна, регион, район, населенный пункт, улица..	ikar:Address	0..1
activityLocation	Название предприятия.	ent:ActivityLocation	0..*

@@ Строка 26: / Строка 26: @@
 ==Данные запроса==
-===Объект getBusinessEntityChangesListRequest===
+===Объект getBusinessEntityByGuidRequest===
-Корневой объект запроса. По умолчанию содержит параметры запрашиваемого списка.
+Корневой объект запроса. Содержит уникальный глобальный идентификатор хозяйствующего субъекта.
 {| class="wikitable"
@@ Строка 34: / Строка 34: @@
 ! Поле !! Описание !! Тип данных !! Обязательность
 |-
-| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
+| '''GUID''' || Глобальный идентификатор в реестре РСХН. || [[UUID|bs:UUID]] || 1
-|-
-| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за который выбираются изменения. || [[DateInterval|bs:DateInterval]] || 1
-|}
-===Объект [[#Объект getBusinessEntityChangesListRequest|..Request]]/listOptions===
-Объект содержит параметры запрашиваемого списка продукции.
-{| class="wikitable"
-|-
-! Поле !! Описание !! Тип данных !! Обязательность
-|-
-| '''count''' || Количество значений в списке
-* По умолчанию значение равно 100;
-* Максимально допустимое значение равно 1000
-|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
-|-
-| '''offset''' || Смещение в списке относительно начала || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
-|}
-===Объект [[#Объект getBusinessEntityChangesListRequest|..Request]]/'''updateDateInterval'''===
-Объект содержит данные об интервале дат, за которые происходили изменения.
-{| class="wikitable"
-|-
-! Поле !! Описание !! Тип данных !! Обязательность
-|-
-| '''beginDate''' || Начальная дата интервала || [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
-|-
-| '''endDate''' || Конечная дата интервала
-* Если конечная дата не указана, то по умолчанию используется текущая дата
-|| [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 0..1
 |}