GetReferenceData: TypesOfCargo — Виды грузов
Функция позволяет получить список видов грузов (груз, документы и т.д.), необходимых для использования в других методах 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>TypesOfCargo</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.
Иерархия структуры parameters:
parameters → List (массив) → каждый элемент List → Key, Value, ValueType.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Reference | string | Имя справочника, должно быть равно «TypesOfCargo» |
Параметр Element в ответе содержит информацию о видах грузов.
Он включает элементы справочника:
Key: строка со значением TypesOfCargo;
List: непустой массив элементов, каждый из которых содержит информацию о конкретном виде груза.
Каждый документ из списка List в виде структуры Element содержит в себе:
- Key: Уникальный номер элемента справочника в формате GUID (например, 81dd8a13-8235-494f-84fd-9c04c51d50ec);
- Value: наименование груза (например, Документы);
- ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
- Fields: контейнер для других свойств элемента справочника.
Структура ответа иерархична:
Element → Key + List (массив) → каждый элемент List → Key + Value +ValueType +Fields → каждый элемент Fields → Key, Value, ValueType.
Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | Уникальный номер элемента справочника в формате GUID (Globally Unique Identifier) | |
| Value | string | Наименование вида груза | |
| Fields | Element | Другие свойства элемента справочника |
Контейнер Fields содержит в себе элементы:
- Key: имя дополнительного поля (например, Default);
- Value: значение поля (является ли данный вид груза значением по умолчанию) true/false ;
- ValueType: тип значения — строка, указывающая тип Value (string, boolean и т.п.).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Default | boolean | Признак вида груза, используемого по умолчанию |
<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>TypesOfCargo</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>TypesOfCargo</m:Key>
<m:List>
<m:Key>81dd8a13-8235-494f-84fd-9c04c51d50ec</m:Key>
<m:Value xsi:type="xs:string">Документы</m:Value>
<m:ValueType>string</m:ValueType>
<m:Fields>
<m:Key>Default</m:Key>
<m:Value xsi:type="xs:boolean">true</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
</m:List>
<m:List>
<m:Key>4aab1fc6-fc2b-473a-8728-58bcd4ff79ba</m:Key>
<m:Value xsi:type="xs:string">Груз</m:Value>
<m:ValueType>string</m:ValueType>
<m:Fields>
<m:Key>Default</m:Key>
<m:Value xsi:type="xs:boolean">false</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
</m:List>
<m:List>
<m:Key>f132d9fa-a944-4c11-9001-f4dfdd13b4a7</m:Key>
<m:Value xsi:type="xs:string">Негабаритный груз</m:Value>
<m:ValueType>string</m:ValueType>
<m:Fields>
<m:Key>Default</m:Key>
<m:Value xsi:type="xs:boolean">false</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
</m:List>
<m:List>
<m:Key>dd80f922-a010-422a-b26a-0a65a6f894ce</m:Key>
<m:Value xsi:type="xs:string">Опасный груз</m:Value>
<m:ValueType>string</m:ValueType>
<m:Fields>
<m:Key>Default</m:Key>
<m:Value xsi:type="xs:boolean">false</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
</m:List>
<m:List>
<m:Key>091861e3-e3a0-11eb-9259-005056bbb928</m:Key>
<m:Value xsi:type="xs:string">Сборный груз</m:Value>
<m:ValueType>string</m:ValueType>
<m:Fields>
<m:Key>Default</m:Key>
<m:Value xsi:type="xs:boolean">false</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
</m:List>
<m:List>
<m:Key>7b24f206-e8d1-11ed-8ad9-005056bbb928</m:Key>
<m:Value xsi:type="xs:string">для теста</m:Value>
<m:ValueType>string</m:ValueType>
<m:Fields>
<m:Key>Default</m:Key>
<m:Value xsi:type="xs:boolean">false</m:Value>
<m:ValueType>boolean</m:ValueType>
</m:Fields>
</m:List>
</m:return>
</m:GetReferenceDataResponse>
</soap:Body>
</soap:Envelope>