GetReferenceData: Repository — Склады
Функция позволяет получить список складов для клиента, необходимых для использования в других функциях при вызове 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>Repository</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.
Иерархия структуры parameters:
parameters→ List (массив) → каждый элемент List→ Key, Value, ValueType.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Reference | string | Имя справочника, должно быть равно «Repository» |
Параметр Element в ответе содержит информацию о списке доступных складов с их географической привязкой.
Он включает элементы справочника:
Key: идентификатор справочника, строка со значением Repository;
List: массив элементов справочника.
Каждый блок List описывает один склад и содержит в себе:
- Key: уникальный идентификатор склада (например, fb49acea-d283-11e2-83ed-001e670c26ac);
- Value: техническое наименование или код склада для внутреннего использования (например, GuidStore);
- ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
- Fields: контейнер для одного дополнительного атрибута склада.
Структура ответа иерархична:
Element→ Key + List (массив) → каждый элемент List→ Key + Value +ValueType +Fields→ каждый элемент Fields→ Key, Value, ValueType.
Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | GuidStore фиксированное значение ключа | |
| Value | string | Уникальный номер элемента справочника в формате GUID (Globally Unique Identifier) | |
| Fields | Element | Другие свойства элемента справочника |
Каждый блок Fields содержит в себе расширенную информацию о конкретном складе:
- Key: идентификатор поля (например, GuidStore, NameStore);
- Value: значение поля;
- ValueType: тип значения — строка, указывающая тип Value (string, boolean и т.п.).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| GuidStore | string | Идентификатор склада в формате GUID | |
| NameStore | string | Наименование склада | |
| GuidGeography | string | GUID географии - идентификатор местоположения склада | |
| NameGeography | 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>Repository</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>Repository</m:Key>
<m:List>
<m:Key>fb49acea-d283-11e2-83ed-001e670c26ac</m:Key>
<m:Value xsi:type="xs:string">GuidStore</m:Value>
<m:ValueType>string</m:ValueType>
<m:Fields>
<m:Key>GuidStore</m:Key>
<m:Value xsi:type="xs:string">fb49acea-d283-11e2-83ed-001e670c26ac</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>NameStore</m:Key>
<m:Value xsi:type="xs:string">Товары Интернет магазинов</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>GuidGeography</m:Key>
<m:Value xsi:type="xs:string">cf862f56-442d-11dc-9497-0015170f8c09</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>NameGeography</m:Key>
<m:Value xsi:type="xs:string">Москва г</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
</m:List>
<m:List>
<m:Key>e7c6c1b5-4f2f-11e2-917a-001e670c26ad</m:Key>
<m:Value xsi:type="xs:string">GuidStore</m:Value>
<m:ValueType>string</m:ValueType>
<m:Fields>
<m:Key>GuidStore</m:Key>
<m:Value xsi:type="xs:string">e7c6c1b5-4f2f-11e2-917a-001e670c26ad</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>NameStore</m:Key>
<m:Value xsi:type="xs:string">Склад товаров АЗЛК</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>GuidGeography</m:Key>
<m:Value xsi:type="xs:string">cf862f56-442d-11dc-9497-0015170f8c09</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
<m:Fields>
<m:Key>NameGeography</m:Key>
<m:Value xsi:type="xs:string">Москва г</m:Value>
<m:ValueType>string</m:ValueType>
</m:Fields>
</m:List>
</m:return>
</m:GetReferenceDataResponse>
</soap:Body>
</soap:Envelope>