Exportcenter:GetLegalEntityChangesList:v2.0: различия между версиями

Версия 00:08, 8 сентября 2021

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

Операция GetBusinessEntityChangesList предназначена для получения списка хозяйствующих субъектов, изменённых в указанный период времени. В общем случае в список могут попасть не актуальные и/или не последние записи (active=false, last=false). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка хозяйствующих субъектов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.

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

параметры выводимого списка;
период, за который необходимо получить изменения.

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

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

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getBusinessEntityChangesListRequest>
002	···<bs:listOptions>	bs:ListOptions	[0..1]	Параметры запрашиваемого списка.
003	······<bs:count>10</bs:count>	xs:nonNegativeInteger	[0..1]	Максимальное запрашиваемое количество объектов в списке. По умолчанию значение 100; Максимально возможное значение 1000.
004	······<bs:offset>2</bs:offset>	xs:nonNegativeInteger	[0..1]	Номер элемента, по которому осуществляется смещение первого элемента списка. По умолчанию значение 0.
005	···</bs:listOptions>
006	···<bs:updateDateInterval>	bs:DataInterval	[1..1]	Интервал времени обновления. В список попадают все записи, дата обновлений которых попадает в указанный интервал.
007	······<bs:beginDate>2017-07-07T00:00:00</bs:beginDate>	xs:dateTime	[1..1]	Начало временного интервала.
008	······<bs:endDate>2017-07-25T00:00:00</bs:endDate>	xs:dateTime	[0..1]	Конец временного интервала. Текущий день, если не указано.
009	···</bs:updateDateInterval>
010	</ws:getBusinessEntityChangesListRequest>

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

Описание ошибок

Ошибка	Описание
InternalServiceFault	Внутренняя ошибка сервиса.
IncorrectRequestFault	Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd.
OffsetOutOfRangeFault	Заданный в запросе отступ больше числа записей в результате запроса.

@@ Строка 1: / Строка 1: @@
+==Общие сведения==
+Операция '''GetBusinessEntityChangesList''' предназначена для получения списка хозяйствующих субъектов, изменённых в указанный период времени. В общем случае в список могут попасть не актуальные и/или не последние записи (active=false, last=false). Поддерживается возможность постраничного вывода. Выполнение операции заканчивается либо возвратом списка хозяйствующих субъектов, либо ошибкой, в случае если параметры запроса не корректны или произошла иная ошибка выполнения запроса.
+<!--===Используемые пространства имён и типы===
+{{столбцы}}
+{{столбец}}
+* [[NameSpaces#http://www.w3.org/2001/XMLSchema|xs]] (<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>)
+** [http://www.w3.org/TR/xmlschema-2/#boolean xs:boolean]
+** [http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
+** [http://www.w3.org/TR/xmlschema-2/#string xs:string]
+** [http://www.w3.org/TR/xmlschema-2/#string xs:integer]
+** [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
+{{столбец}}
+*  [[NameSpaces#http://api.vetrf.ru/schema/cdm/cerberus/enterprise|ent]] (<nowiki>http://api.vetrf.ru/schema/cdm/cerberus/enterprise</nowiki>)
+** [[BusinessEntityList|ent:BusinessEntityList]]
+** [[BusinessEntity|ent:BusinessEntity]]
+** [[BusinessEntityType|ent:BusinessEntityType]]
+** [[IncorporationForm|ent:IncorporationForm]]
+{{столбец}}
+* [[NameSpaces#http://api.vetrf.ru/schema/cdm/base|bs]] (<nowiki>http://api.vetrf.ru/schema/cdm/base</nowiki>)
+** [[UUID|bs:UUID]]
+** [[ListOptions|bs:ListOptions]]
+** [[String255|bs:String255]]
+* [[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]] (<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
+** [[Address|ikar:Address]]
+{{столбец}}
+* [[NameSpaces#http://api.vetrf.ru/schema/cdm/ikar|ikar]] (<nowiki>http://api.vetrf.ru/schema/cdm/ikar</nowiki>)
+** [[Country|ikar:Country]]
+** [[Region|ikar:Region]]
+** [[District|ikar:District]]
+** [[Locality|ikar:Locality]]
+** [[Street|ikar:Street]]
+{{столбцы/конец}}-->
+===Входные данные===
+* параметры выводимого списка;
+* период, за который необходимо получить изменения.
+===Выходные данные===
+* список изменённых за указанный период хозяйствующих субъектов.
+==Спецификация запроса==
+{| class="wikitable"
+! #
+! Название XML-элемента
+! Тип
+! Обязат.
+! Описание (нажмите [...] для отображения дополнительного описания)
+|-
+|001
+|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''<ws:getBusinessEntityChangesListRequest>'''}}
+|
+|
+| style="width:52em;"|
+|-
+|002
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}listOptions>'''}}
+|[[ListOptions|bs:ListOptions]]
+|[0..1]
+| style="width:52em;"| Параметры запрашиваемого списка.
+|-
+|003
+|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}count>'''}}{{color|#131313|10}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}count>'''}}
+|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
+|[0..1]
+|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
+<span style="white-space:nowrap; font-weight: normal;">Максимальное запрашиваемое количество объектов в списке.
+</span>
+<div class="mw-collapsible-content" style="font-weight: normal;">
+* По умолчанию значение 100;
+* Максимально возможное значение 1000.</div>
+</div>
+|-
+|004
+|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}offset>'''}}{{color|#131313|2}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}offset>'''}}
+|[http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger]
+|[0..1]
+|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
+<span style="white-space:nowrap; font-weight: normal;">Номер элемента, по которому осуществляется смещение первого элемента списка.
+</span>
+<div class="mw-collapsible-content" style="font-weight: normal;">
+* По умолчанию значение 0.</div>
+</div>
+|-
+|005
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}listOptions>'''}}
+|
+|
+| style="width:52em;"|
+|-
+|006
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''<{{color|#660e7a|bs:}}updateDateInterval>'''}}
+|[[DataInterval|bs:DataInterval]]
+|[1..1]
+|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
+<span style="white-space:nowrap; font-weight: normal;"> Интервал времени обновления.
+</span>
+<div class="mw-collapsible-content" style="font-weight: normal;">
+* В список попадают все записи, дата обновлений которых попадает в указанный интервал.</div>
+</div>
+|-
+|007
+|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}beginDate>'''}}{{color|#131313|2017-07-07T00:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}beginDate>'''}}
+|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
+|[1..1]
+| style="width:52em;"|  Начало временного интервала.
+|-
+|008
+|style="font-weight: ; font-family: Courier;" |······{{color|#190dbf|'''<{{color|#660e7a|bs:}}endDate>'''}}{{color|#131313|2017-07-25T00:00:00}}{{color|#190dbf|'''</{{color|#660e7a|bs:}}endDate>'''}}
+|[http://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime]
+|[0..1]
+|<div class="mw-collapsible mw-collapsed" data-expandtext="&nbsp;...&nbsp;" data-collapsetext="свернуть" style="font-weight: bold; width:52em;">
+<span style="white-space:nowrap; font-weight: normal;">Конец временного интервала.
+</span>
+<div class="mw-collapsible-content" style="font-weight: normal;">
+* Текущий день, если не указано.</div>
+</div>
+|-
+|009
+|style="font-weight: ; font-family: Courier;" |···{{color|#190dbf|'''</{{color|#660e7a|bs:}}updateDateInterval>'''}}
+|
+|
+| style="width:52em;"|
+|-
+|010
+|style="font-weight: ; font-family: Courier;" |{{color|#190dbf|'''</ws:getBusinessEntityChangesListRequest>'''}}
+|
+|
+| style="width:52em;"|
+|-
+|}
+==Спецификация ответа==
+==Описание ошибок==
+{| class="wikitable"
+|-
+! Ошибка <!--!! Пространство имён--> !! Описание
+|-
+| '''InternalServiceFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Внутренняя ошибка сервиса.
+|-
+| '''IncorrectRequestFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Некорректный запрос. Возникает, если запрос не соответствует требованиям указанным в xsd.
+|-
+| '''OffsetOutOfRangeFault''' <!--|| namespace=”http://api.vetrf.ru/schema/cdm/ikar/ws-definitions”--> || Заданный в запросе отступ больше числа записей в результате запроса.
+|}