GetReferenceData: Countries — Классификатор стран мира
Функция позволяет получить страны мира, которые необходимо передавать при создании серийного номера (страна товара) товаров определенной категории (обувь, изделия из меха, лекарственные препараты и табачная продукция).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| 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>countries</car:Value>
<car:ValueType>string</car:ValueType>
</car:List>Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.
Иерархия структуры parameters:
parameters → List (массив) → каждый элемент List → Key, Value, ValueType.
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Reference | string | Имя справочника, должно быть равно «countries». |
Параметр Element в ответе содержит информацию о странах мира, которые необходимы для создания серийного номера.
Он включает элементы справочника:
Key: идентификатор справочника, к которому относится запись ;
List: контейнер записи справочника.
Каждая запись справочника из списка List в виде структуры Element содержит в себе:
- Key: Уникальный идентификатор страны (GUID) (например, 0837e701-01f4-11ea-9985-005056bb6b60);
- Value: наименование страны;
- ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.).
Структура ответа иерархична:
Element → Key + List (массив) → каждый элемент List → Key + Value +ValueType.
Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| Key | string | GUID страны | |
| 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>countries</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>Countries</m:Key>
<m:List>
<m:Key>05a6c871-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АФГАНИСТАН</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c872-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АЛБАНИЯ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c873-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АНТАРКТИДА</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c874-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АЛЖИР</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c876-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АМЕРИКАНСКОЕ САМОА</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c875-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АНДОРРА</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c877-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АНГОЛА</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c878-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АНТИГУА И БАРБУДА</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>42131199-4b2c-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АЗЕРБАЙДЖАН</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>600d7f0c-4fed-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АРГЕНТИНА</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>600d7f0d-4fed-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АВСТРАЛИЯ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>600d7f0e-4fed-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АВСТРИЯ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>600d7f0f-4fed-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">БАГАМЫ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c879-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">БАХРЕЙН</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>600d7f10-4fed-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">БАНГЛАДЕШ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>d5d4519b-442d-11dc-9497-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">АРМЕНИЯ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c87a-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">БАРБАДОС</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>600d7f11-4fed-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">БЕЛЬГИЯ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c87c-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">БЕРМУДЫ</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c87d-4ff3-11dc-bda1-0015170f8c09</m:Key>
<m:Value xsi:type="xs:string">БУТАН</m:Value>
<m:ValueType>string</m:ValueType>
</m:List>
<m:List>
<m:Key>05a6c87e-4ff3-11dc-bda1-0015170f8c09</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> 