GetReferenceData: BaseUnitsOfMeasurement — Базовые единицы измерения
Функция позволяет получить список базовых единиц измерения, использующиеся в других функциях при вызове web-сервиса.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| login | string | логин | |
| password | string | пароль | |
| parameters | Element | список параметров |
Параметр parameters содержит настройки запроса в виде иерархической структуры, соответствующей XML-представлению.
Он должен включать:
Key: строка со значением parameters (обязательное);
List: непустой массив элементов, каждый из которых представляет отдельный параметр и сам является структурой с тремя полями:
- Key: имя параметра (например, Reference);
- Value: значение параметра указывающая на то какой parameters описывается;
- ValueType: тип значения — строка, указывающая тип Value(string, int и т.д.).
Пример одного элемента из List:
<car:List>
<car:Key>Reference</car:Key>
<car:Value>BaseUnitsOfMeasurement</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.
Иерархия структуры parameters:
parameters → List (массив) → каждый элемент List → Key, Value, ValueType.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Reference | string | Имя справочника, должно быть равно «BaseUnitsOfMeasurement» |
Параметр Element в ответе содержит информацию о видах грузов.
Он включает элементы справочника:
Key: идентификатор справочника, к которому относится запись (например, BaseUnitsOfMeasurement);
List: контейнер записи справочника.
Каждый блок List в виде структуры Element описывает одну единицу измерения и содержит следующие элементы:
- Key: уникальный идентификатор записи (GUID) (например, 49be4853-2a2d-11e5-9c33-005056b1a128);
- Value: кодовое или краткое наименование единицы измерения;
- ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.).
Структура ответа иерархична:
Element → Key + List (массив) → каждый элемент List → Key + Value +ValueType.
Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | GUID (Globally Unique Identifier) базовой единицы измерения | |
| Value | string | Наименование базовой единицы измерения |
<soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:car="http://www.cargo3.ru">
<soap:Header/>
<soap:Body>
<car:GetReferenceData>
<car:login>test</car:login>
<car:password>2016</car:password>
<car:parameters>
<car:Key>parameters</car:Key>
<car:List>
<car:Key>Reference</car:Key>
<car:Value>BaseUnitsOfMeasurement</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>
</car:parameters>
</car:GetReferenceData>
</soap:Body>
</soap:Envelope><soap:Envelope
xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
<soap:Body>
<m:GetReferenceDataResponse
xmlns:m="http://www.cargo3.ru">
<m:return
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<m:Key>BaseUnitsOfMeasurement</m:Key>
<m:List>
<m:Key>49be4853-2a2d-11e5-9c33-005056b1a128</m:Key>
<m:Value xsi:type="xs:string">F01</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>c079173e-eec9-11e6-9e93-005056b1a128</m:Key>
<m:Value xsi:type="xs:string">F02</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>5e300677-eed5-11e6-9e93-005056b1a128</m:Key>
<m:Value xsi:type="xs:string">F03</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>d6533f63-f8ea-11e6-9e93-005056b1a128</m:Key>
<m:Value xsi:type="xs:string">F04</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>ad527cf6-f311-11e4-a887-001e67086478</m:Key>
<m:Value xsi:type="xs:string">F05</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>601632df-976d-11dc-986e-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">кг</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>37dec53b-e399-11dd-927a-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">км</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>601632de-976d-11dc-986e-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">м3</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>1e3777e4-a81e-11e2-833c-001e670c42dc</m:Key>
<m:Value xsi:type="xs:string">мест</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>de662970-e1be-11ec-b111-005056bbb928</m:Key>
<m:Value xsi:type="xs:string">пар</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>37dec53a-e399-11dd-927a-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">см</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>0232d433-c84d-11dd-927a-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">Упк</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>a227bc37-904c-11dd-9204-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">Услуга</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>601632e1-976d-11dc-986e-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">ч</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>601632e2-976d-11dc-986e-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">шт</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>35e389bd-e49d-11e2-bc28-001e67086478</m:Key>
<m:Value xsi:type="xs:string">шт/сут</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
</m:return>
</m:GetReferenceDataResponse>
</soap:Body>
</soap:Envelope>