GetReferenceData: CountryCodes — Коды стран

• Endpoint: GetReferenceData
• SOAP-метод: CountryCodes
• Группа: GetReferenceData
• Создано: 16.04.2026 · Обновлено: 18.05.2026

Описание

Функция позволяет получить список кодов стран в следующих форматах: цифровой, альфа-2, альфа-3. Полученные данные используются при последующих вызовах других функций веб-сервиса.

Режимы работы функции:

1\. Получение всех стран

Условие: параметры Search и InGroup не переданы

Результат: возвращаются все записи справочника «Страны мира» с соответствующими кодами

2\. Поиск по наименованию

Условие: передан параметр Search

Результат: возвращаются данные только для страны, наименование которой точно совпадает с указанным в параметре Search. Наименование должно соответствовать названию страны в базе «Карго»

3\. Поиск по GUID

Условие: передан параметр InGroup

Результат: Возвращаются данные только для страны, идентификатор которой (GUID) соответствует переданному значению

Параметры запроса

Описание параметра parameters

Параметр parameters содержит настройки запроса в виде иерархической структуры, соответствующей XML-представлению.

Он должен включать:

Key: строка со значением parameters (обязательное);

List: непустой массив элементов, каждый из которых представляет отдельный параметр и сам является структурой с тремя полями:

• Key: имя параметра (например, Reference);
• Value: значение параметра указывающая на то какой parameters описывается;
• ValueType: тип значения — строка, указывающая тип Value(string, int и т.д.).

Пример одного элемента из List:

<car:List>
 <car:Key>Reference</car:Key>
 <car:Value>CountryCodes</car:Value>
 <car:ValueType>string</car:ValueType>
</car:List>

Каждый такой элемент — независимый узел внутри parameters. Если List отсутствует или пуст — запрос отклоняется.

Иерархия структуры parameters:

parameters → List (массив) → каждый элемент List → Key, Value, ValueType.

Возвращаемые параметры

Параметр Element в ответе содержит информацию о видах грузов.

Он включает элементы справочника:

Key: идентификатор справочника, к которому относится запись (например, CountryCodes);

List: контейнер записи справочника.

Каждая запись справочника из списка List в виде структуры Element содержит в себе:

• Key: Уникальный идентификатор записи (GUID) (например, 74573d15-00dd-11e4-8edb-005056b1a128);
• Value: значение записи (основное наименование);
• ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.);
• Fields: набор дополнительных атрибутов записи, повторяющийся элемент.

Структура ответа иерархична:

Element → Key + List (массив) → каждый элемент List → Key + Value +ValueType +Fields→ каждый элемент Fields → Key, Value, ValueType.

---

Если во время запроса произошла ошибка, информация о ней будет отражена в свойстве Properties (см. метод GetReferenceData: ErrorCodes — Коды ошибок).

Возвращаемые параметры Fields

Каждый блок Fields описывает одно дополнительное поле текущей записи справочника внутри List:

• Key: название дополнительного поля (например, FullName,СountryСode);
• Value: значение дополнительного поля (может быть пустым);
• ValueType: тип значения (string, boolean, и т.д.).

Пример запроса (XML Request)

<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>CountryCodes</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Search</car:Key>
          <car:Value>КАЗАХСТАН</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:GetReferenceData>
  </soap:Body>
</soap:Envelope>

Пример ответа (XML Response)

<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>CountryCodes</m:Key>
        <m:List>
          <m:Key>74573d15-00dd-11e4-8edb-005056b1a128</m:Key>
          <m:Value xsi:type="xs:string">КАЗАХСТАН</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>FullName</m:Key>
            <m:Value xsi:type="xs:string">Республика Казахстан</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>СountryСode</m:Key>
            <m:Value xsi:type="xs:string">398</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AlfaCode2</m:Key>
            <m:Value xsi:type="xs:string">KZ</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AlfaCode3</m:Key>
            <m:Value xsi:type="xs:string">KAZ</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>Currency</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>CurrencyGuid</m:Key>
            <m:Value xsi:type="xs:string">00000000-0000-0000-0000-000000000000</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>

Смежные методы