MercuryG2B:GetPurposeList:v3.0

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

1. Операция GetPurposeList предназначена для получения списка актуальных записей направлений груза (active = true, last = true).
2. Поддерживается постраничный вывод.

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getPurposeListRequest>
002	···<bs:listOptions>	bs:ListOptions	[0..1]	Параметры запрашиваемого списка
003	······<bs:count>?</bs:count>	xs:nonNegativeInteger	[0..1]	Максимальное запрашиваемое количество объектов в списке По умолчанию значение 100; Максимально возможное значение 1000.
004	······<bs:offset>?</bs:offset>	xs:nonNegativeInteger	[0..1]	Номер элемента, по которому осуществляется смещение первого элемента списка По умолчанию значение 0.
005	···</bs:listOptions>
006	</ws:getPurposeListRequest>

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

#	Название XML-элемента	Тип	Обязат.	Описание (нажмите [...] для отображения дополнительного описания)
001	<ws:getPurposeListResponse>
002	···<dt:purposeList total="?" offset="?" count="?">	dt:PurposeList	[1..1]	Список направлений total - всего записей; offset - смещение относительно первого элемента; count - количество выводимых записей.
003	······<dt:purpose>	dt:Purpose	[1..1]	Направление
004	·········<bs:uuid>?</bs:uuid>	bs:UUID	[1..1]	Идентификатор версии записи
005	·········<bs:guid>?</bs:guid>	bs:UUID	[1..1]	Глобальный идентификатор записи
006	·········<bs:active>?</bs:active>	xs:boolean	[1..1]	Флаг активности записи true - запись активна; false - запись не активна.
007	·········<bs:last>?</bs:last>	xs:boolean	[1..1]	Флаг, указывающий на то, что запись является последней в истории true - да; false - нет.
008	·········<bs:status>?</bs:status>	bs:VersionStatus	[1..1]	Статус записи
009	·········<bs:createDate>?</bs:createDate>	xs:DateTime	[1..1]	Дата создания записи
010	·········<bs:updateDate>?</bs:updateDate>	xs:DateTime	[1..1]	Дата последнего изменения записи
011	·········<bs:previous>?</bs:previous>	bs:UUID	[0..1]	Идентификатор предыдущей версии записи
012	·········<dt:name>?</dt:name>	bs:String255	[1..1]	Наименование направления
013	·········<dt:intendedUse>?</dt:intendedUse>	dt:IntendedUse	[0..1]	Предназначение груза, к которому относится данное направление Возможные значения: HUMAN_CONSUMPTION - в пищу людям MANUFACTURING_HUMAN_CONSUMPTION - для переработки с целью получения подконтрольных товаров, предназначенных в пищу людям DECONTAMINATION_HUMAN_CONSUMPTION - для переработки с обеззараживанием с целью получения подконтрольных товаров, предназначенных в пищу людям ANIMAL_FEED - в корм животным MANUFACTURING_ANIMAL_FEED - для переработки с целью получения подконтрольных товаров, предназначенных в корм животным MEDICAL_USE - для медицинских целей MANUFACTURING_MEDICAL_USE - для переработки с целью получения подконтрольных товаров, предназначенных для медицинских целей SCIENTIFIC_PURPOSES - для биологических, ветеринарных и биотехнологических целей MANUFACTURING_SCIENTIFIC_PURPOSES - для переработки с целью получения подконтрольных товаров, предназначенных для биологических, ветеринарных и биотехнологических целей LABORATORY_TESTS - для диагностических и иных лабораторных исследований TECHNICAL_PURPOSES - для технических целей DISPOSAL - для утилизации DESTRUCTION - для уничтожения EXAMINATION - для проведения ветеринарно-санитарной экспертизы
014	······</dt:purpose>
015	···</dt:purposeList>
016	</ws:getPurposeListResponse>

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

TODO

См. также

Вернуться к началу ↑
Вернуться на страницу профиля API MercuryG2B:Services:v3.0