GetReferenceData: NumberTypes — Типы дополнительных номеров

SOAP Endpoint: GetReferenceData Обновлено: 2026-05-19

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

Описание

Функция позволяет получить возможные типы дополнительных номеров, используемые в других функциях при вызове web сервиса.

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

Параметр	Тип	Обязательно	Описание
login	string	да	логин
password	string	да	пароль
parameters	Element	да	список параметров

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

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

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

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

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

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

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

xml

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

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

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

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

Параметр	Тип	Обязательно	Описание
Reference	string	да	Имя справочника, должно быть равно «NumberTypes»

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

Параметр Element в ответе содержит информацию о типах дополнительных номеров.

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

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

List: контейнер записи справочника, каждая запись соответствует одному типу номера.

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

Key: уникальный идентификатор типа номера (например, eff49154-8f0c-11e7-a1c2-005056b1a128);
Value: наименование типа номера (например, Номер агента, Номер клиента);
ValueType: тип значения — строка, указывающая тип Value (string, dateTime и т.п.).

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

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

---

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

Параметр	Тип	Обязательно	Описание
Key	string	да	Уникальный номер элемента справочника в формате GUID (Globally Unique Identifier)
Value	string	да	Наименование дополнительного номера

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

xml

<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>NumberTypes</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
      </car:parameters>
    </car:GetReferenceData>
  </soap:Body>
</soap:Envelope>

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

xml

<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>NnumberType</m:Key>
        <m:List>
          <m:Key>c2759a7b-9a08-11e3-a8f9-001e670c42dc</m:Key>
          <m:Value xsi:type="xs:string">Доп номер накладной</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>eff49154-8f0c-11e7-a1c2-005056b1a128</m:Key>
          <m:Value xsi:type="xs:string">Какой-то еще номер для кл</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>74e4e244-8c74-4ae1-9b30-2680a8f27aac</m:Key>
          <m:Value xsi:type="xs:string">Код получателя груза</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>29d89993-4a5e-4c5b-b253-cdf76832448f</m:Key>
          <m:Value xsi:type="xs:string">Номер агента</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>cf5fbc29-b324-4dde-978b-99c17b1cf5aa</m:Key>
          <m:Value xsi:type="xs:string">Номер клиента</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>081fe7cd-d611-4271-b1e0-e1f6aa6928e4</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>

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

AvailableDeliveryDates

Функция позволяет получить информацию о возможных датах доставки груза.

BaseUnitsOfMeasurement

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

CargoStates

Функция позволяет получить список доступных состояний грузов.