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

Материал из Справочная система Россельхознадзора
Перейти к навигации Перейти к поиску
 
(не показано 11 промежуточных версий 2 участников)
Строка 1: Строка 1:
==Общие сведения==
==Общие сведения==


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


===Используемые пространства имён и типы===
===Используемые пространства имён и типы===
Строка 20: Строка 20:
** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
** [https://www.w3.org/TR/xmlschema-2/#string xs:string]
{{столбцы/конец}}
{{столбцы/конец}}
===[[#Объект getUnitChangesListRequest|Входные данные]]===
* параметры выводимого списка;
* интервал дат, за которые неообходимо получить список изменений.
===[[#Объект getUnitChangesListResponse |Выходные данные]]===
* список изменений в записях единиц измерений.


==Данные запроса==
==Данные запроса==
Строка 31: Строка 38:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка  || [[ListOptions|bs:ListOptions]] || 0..1
| [[#Объект ..Request/listOptions|'''listOptions''']] || Параметры запрашиваемого списка. || [[ListOptions|bs:ListOptions]] || 0..1
|-
|-
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за которые требуется получить изменения || [[DateInterval|bs:DateInterval]] || 1
| [[#Объект ..Request/updateDateInterval|'''updateDateInterval''']] || Интервал дат, за которые требуется получить изменения. || [[DateInterval|bs:DateInterval]] || 1
|}
|}


===Объект [[#Объект getUnitChangesListRequest|..Request]]/listOptions===
===Объект [[#Объект getUnitChangesListRequest|..Request]]/'''listOptions'''===


Объект содержит в себе параметры запрашиваемого списка.
Объект содержит в себе параметры запрашиваемого списка.
Строка 44: Строка 51:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| '''count''' || Количество значений в списке
| '''count''' || Количество значений в списке.
* По умолчанию значение равно 100;
* По умолчанию значение равно 100;
* Максимально допустимое значение равно 1000  
* Максимально допустимое значение равно 1000.
|| [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|| [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
| '''offset''' || Смещение в списке относительно начала. || [http://www.w3.org/TR/xmlschema-2/#nonNegativeInteger xs:nonNegativeInteger] || 0..1
|-
|-
|}
|}


===Объект [[#Объект getUnitChangesListRequest|..Request]]/updateDateInterval===
===Объект [[#Объект getUnitChangesListRequest|..Request]]/'''updateDateInterval'''===


Объект содержит сведения об интервале времени, за который необходимо получить обновления.
Объект содержит сведения об интервале времени, за который необходимо получить обновления.
Строка 77: Строка 84:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| [[#Объект ..Response/unitList|'''unitList''']] || Сущность, описывающая список единиц измерения || [[UnitList|argc:UnitList]] || 1
| [[#Объект ..Response/unitList|'''unitList''']] || Сущность, описывающая список единиц измерения. || [[UnitList|argc:UnitList]] || 1
|}
|}




===Объект [[#Объект getUnitChangesListResponse|..Response]]/unitList===
===Объект [[#Объект getUnitChangesListResponse|..Response]]/'''unitList'''===


Объект содержит множество сущностей, описывающих единицу измерения.
Объект содержит множество сущностей, описывающих единицу измерения.
Строка 89: Строка 96:
! Поле !! Описание !! Тип данных !! Обязательность
! Поле !! Описание !! Тип данных !! Обязательность
|-
|-
| [[#Объект ..Response/unitList/unit|'''unit''']] || Сущность, описывающая единицу измерения || [[Unit|argc:Unit]] || 1
| [[#Объект ..Response/unitList/unit|'''unit''']] || Сущность, описывающая единицу измерения. || [[Unit|argc:Unit]] || 1
|}
|}


'''Атрибуты списка unitList'''
{{Ветис.API EntityList Attributes}}
===Объект [[#Объект getUnitChangesListResponse|..Response]]/[[#Объект ..Response/unitList|unitList]]/'''unit'''===


===Объект [[#Объект getUnitByUuidResponse|..Response]]/[[#Объект ..Response/unitList|unitList]]/'''unit'''===
Объект содержит данные о единице измерения.


Объект содержит данные о назначении груза.
{{Ветис.API Dictionary Unit|1}}
 
==Описание ошибок==


{| class="wikitable"
{| class="wikitable"
|-
|-
! Поле !! Описание !! Тип !! Обязательность
! Ошибка !! Описание
|-
| '''UUID''' || Идентификатор версии записи о единице измерения в реестре РСХН || [[UUID|bs:UUID]] || 1
|-
| '''GUID''' || Глобальный идентификатор единицы измерения в реестре РСХН || [[UUID|bs:UUID]] || 1
|-
| '''active''' || Флаг, указывающий на то, активна ли запись. || [https://www.w3.org/TR/xmlschema-2/#boolean xs:boolean] || 1
|-
| '''status''' || Статус версии записи || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
| '''createDate''' || Дата создания записи о единице измерения в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''updateDate''' || Дата последнего обновления записи в реестре РСХН || [https://www.w3.org/TR/xmlschema-2/#dateTime xs:dateTime] || 1
|-
| '''previous''' || Идентификатор предыдущей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''next''' || Идентификатор следующей версии записи || [[UUID|bs:UUID]] || 0..1
|-
| '''name''' || Краткое название единицы измерения || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
|-
|-
| '''fullName''' || Полное название единицы измерения || [https://www.w3.org/TR/xmlschema-2/#string xs:string] || 1
| '''InternalServiceFault''' || Внутренняя ошибка сервиса.
|-
|-
| '''commonUnitGuid''' || Глобальный идентификатор базовой единицы измерения. Например, для центнера, тонны, тыс.тонн базовой единицей измерения является килограмм || [[UUID|bs:UUID]] || 1
| '''IncorrectRequestFault''' || Некорректный  запрос.   Происходит  в  случае,   если  запрос  не  соответствует  требованиям указанным в xsd.
|-
|-
| '''factor''' || Коэффициент относительно базовой единицы измерения. Например, для тонны этот коэффициент равен 1000, т.к. в 1 тонне 1000 кг. Для килограмма этот коэффициент равен единице.  || [https://www.w3.org/TR/xmlschema-2/#integer xs:integer] || 1
| '''OffsetOutOfRangeFault''' || Заданный в запросе отступ больше числа записей в результате запроса.
|}
|}
==Пример запроса==
==Пример запроса==
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Запрос данных о килограмме
Запрос первых трех единиц измерения, измененных в период с 01.01.2010 по текущий день, со смещением равным единице.
<div class = "mw-collapsible-content">
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
Строка 134: Строка 129:
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions"  
                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions"  
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base">
                   xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Header/>
  <soapenv:Body>
  <soapenv:Body>
       <ws:getUnitByUuidRequest>
    <ws:getUnitChangesListRequest>
        <base:uuid>069792f0-053d-11e1-99b4-d8d385fbc9e8</base:uuid>
       <base:listOptions>
       </ws:getUnitByUuidRequest>
        <base:count>3</base:count>
  </soapenv:Body>
        <base:offset>1</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2010-01-01T00:00:00</base:beginDate>
        <base:endDate></base:endDate>
      </base:updateDateInterval>
    </ws:getUnitChangesListRequest>
  </soapenv:Body>
</soapenv:Envelope>
</syntaxhighlight>
</div>
</div>
<br />
<div class="toccolours mw-collapsible mw-collapsed" style="width:100%">
Ответ на запрос.
<div class = "mw-collapsible-content">
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getUnitChangesListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base"
                                  xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common"
                                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions">
      <com:unitList count="3" total="4" offset="1">
        <com:unit>
          <bs:uuid>0697a592-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>1146c5f8-d9f4-43a7-85a6-5431bea22520</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2010-02-18T22:44:45+03:00</bs:createDate>
          <bs:updateDate>2010-02-18T22:44:45+03:00</bs:updateDate>
          <com:name>упаковка</com:name>
          <com:fullName>упаковка</com:fullName>
          <com:commonUnitGuid>1146c5f8-d9f4-43a7-85a6-5431bea22520</com:commonUnitGuid>
          <com:factor>1</com:factor>
        </com:unit>
        <com:unit>
          <bs:uuid>0697a61e-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>2288d216-cb78-41f8-9c25-dbeabce76eae</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2010-04-01T13:56:12+03:00</bs:createDate>
          <bs:updateDate>2010-04-01T13:56:12+03:00</bs:updateDate>
          <com:name>мешок</com:name>
          <com:fullName>мешки</com:fullName>
          <com:commonUnitGuid>2288d216-cb78-41f8-9c25-dbeabce76eae</com:commonUnitGuid>
          <com:factor>1</com:factor>
        </com:unit>
        <com:unit>
          <bs:uuid>0697a6b4-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>8a080965-fd21-4fb3-b635-efed9515ec34</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2010-11-24T15:28:56+03:00</bs:createDate>
          <bs:updateDate>2010-11-24T15:28:56+03:00</bs:updateDate>
          <com:name>канистра</com:name>
          <com:fullName>канистра</com:fullName>
          <com:commonUnitGuid>8a080965-fd21-4fb3-b635-efed9515ec34</com:commonUnitGuid>
          <com:factor>1</com:factor>
        </com:unit>
       </com:unitList>
    </ws:getUnitChangesListResponse>
  </S:Body>
</soapenv:Envelope>
</soapenv:Envelope>
</syntaxhighlight>
</syntaxhighlight>
</div>
</div>
</div>
</div>
[[Category:Ветис.API]]
[[Category:DictionaryService]]
[[Category:Реестры]]

Текущая версия на 09:27, 16 декабря 2016

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

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

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

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

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

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

  • список изменений в записях единиц измерений.

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

Объект getUnitChangesListRequest

Корневой объект запроса. В нём указаны параметры запрашиваемого списка и интервал дат, за который запрашиваются изменения.

Поле Описание Тип данных Обязательность
listOptions Параметры запрашиваемого списка. bs:ListOptions 0..1
updateDateInterval Интервал дат, за которые требуется получить изменения. bs:DateInterval 1

Объект ..Request/listOptions

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

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

Объект ..Request/updateDateInterval

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

Поле Описание Тип Обязательность
beginDate Дата, начиная с которой пользователь получит историю изменений записей. xs:dateTime 1
endDate Конец временного интервала.
  • В случае, если компонента endDate не указана, то используется текущая дата.
xs:dateTime 0..1

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

Объект getUnitChangesListResponse

Корневой элемент ответа. Содержит список изменённых единиц измерения.

Поле Описание Тип данных Обязательность
unitList Сущность, описывающая список единиц измерения. argc:UnitList 1


Объект ..Response/unitList

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

Поле Описание Тип данных Обязательность
unit Сущность, описывающая единицу измерения. argc:Unit 1

Атрибуты списка unitList

Атрибут Описание Тип данных Обязательность
count Количество элементов списка, запрашиваемое или переданное. xs:int 1
total Общий размер списка. xs:long 1
offset Смещение первого элемента списка относительно его начала. xs:int 1

Объект ..Response/unitList/unit

Объект содержит данные о единице измерения.

Поле Описание Тип Обязательность
UUID Идентификатор версии записи о единице измерения в реестре Россельхознадзора. bs:UUID 1
GUID Глобальный идентификатор единицы измерения в реестре Россльхознадзора. bs:UUID 1
active Флаг, указывающий на то, активна ли запись. xs:boolean 1
last Флаг, указывающий на то, последняя ли запись. xs:boolean 1
status Статус версии записи. xs:string 1
createDate Дата создания записи о единице измерения в реестре Россельхознадзора. xs:dateTime 1
updateDate Дата последнего обновления записи в реестре Россельхознадзора. xs:dateTime 1
previous Идентификатор предыдущей версии записи. bs:UUID 0..1
next Идентификатор следующей версии записи. bs:UUID 0..1
name Краткое название единицы измерения. xs:string 1
fullName Полное название единицы измерения. xs:string 1
commonUnitGuid Глобальный идентификатор базовой единицы измерения.
  • Например, для тонны базовой единицей измерения является килограмм.
bs:UUID 1
factor Коэффициент относительно базовой единицы измерения.
  • Например, для тонны этот коэффициент равен 1000, т.к. в 1 тонне 1000 кг. Для килограмма этот коэффициент равен единице.
xs:integer 1

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

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

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

Запрос первых трех единиц измерения, измененных в период с 01.01.2010 по текущий день, со смещением равным единице.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
                  xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions" 
                  xmlns:base="http://api.vetrf.ru/schema/cdm/base">
  <soapenv:Header/>
  <soapenv:Body>
    <ws:getUnitChangesListRequest>
      <base:listOptions>
        <base:count>3</base:count>
        <base:offset>1</base:offset>
      </base:listOptions>
      <base:updateDateInterval>
        <base:beginDate>2010-01-01T00:00:00</base:beginDate>
        <base:endDate></base:endDate>
      </base:updateDateInterval>
    </ws:getUnitChangesListRequest>
  </soapenv:Body>
</soapenv:Envelope>


Ответ на запрос.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <ws:getUnitChangesListResponse xmlns:bs="http://api.vetrf.ru/schema/cdm/base" 
                                   xmlns:com="http://api.vetrf.ru/schema/cdm/argus/common" 
                                   xmlns:ws="http://api.vetrf.ru/schema/cdm/argus/common/ws-definitions">
      <com:unitList count="3" total="4" offset="1">
        <com:unit>
          <bs:uuid>0697a592-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>1146c5f8-d9f4-43a7-85a6-5431bea22520</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2010-02-18T22:44:45+03:00</bs:createDate>
          <bs:updateDate>2010-02-18T22:44:45+03:00</bs:updateDate>
          <com:name>упаковка</com:name>
          <com:fullName>упаковка</com:fullName>
          <com:commonUnitGuid>1146c5f8-d9f4-43a7-85a6-5431bea22520</com:commonUnitGuid>
          <com:factor>1</com:factor>
        </com:unit>
        <com:unit>
          <bs:uuid>0697a61e-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>2288d216-cb78-41f8-9c25-dbeabce76eae</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2010-04-01T13:56:12+03:00</bs:createDate>
          <bs:updateDate>2010-04-01T13:56:12+03:00</bs:updateDate>
          <com:name>мешок</com:name>
          <com:fullName>мешки</com:fullName>
          <com:commonUnitGuid>2288d216-cb78-41f8-9c25-dbeabce76eae</com:commonUnitGuid>
          <com:factor>1</com:factor>
        </com:unit>
        <com:unit>
          <bs:uuid>0697a6b4-053d-11e1-99b4-d8d385fbc9e8</bs:uuid>
          <bs:guid>8a080965-fd21-4fb3-b635-efed9515ec34</bs:guid>
          <bs:active>true</bs:active>
          <bs:last>true</bs:last>
          <bs:status>100</bs:status>
          <bs:createDate>2010-11-24T15:28:56+03:00</bs:createDate>
          <bs:updateDate>2010-11-24T15:28:56+03:00</bs:updateDate>
          <com:name>канистра</com:name>
          <com:fullName>канистра</com:fullName>
          <com:commonUnitGuid>8a080965-fd21-4fb3-b635-efed9515ec34</com:commonUnitGuid>
          <com:factor>1</com:factor>
        </com:unit>
      </com:unitList>
    </ws:getUnitChangesListResponse>
  </S:Body>
</soapenv:Envelope>