Перейти к содержимому

GetReferenceData: Urgencies — Срочности

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

SOAP Endpoint: GetReferenceData Обновлено: 2026-05-19
  • Endpoint: GetReferenceData
  • SOAP-метод: Urgencies
  • Группа: 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>Urgencies</car:Value>
 <car:ValueType>string</car:ValueType>
</car:List>

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

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

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

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

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

Параметр Element в ответе содержит информацию о видах срочности доставки.

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

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

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

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

  • Key: уникальный идентификатор вида срочности (например,18c4f207-458b-11dc-9497-0015170f8c09);
  • 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

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

  • Key: название поля (например, DeletionMark);
  • Value: значение поля (может быть пустым);
  • ValueType: тип значения (string, boolean, и т.д.).
Параметр
Тип
Обязательно
Описание
Information
string
нет
Дополнительная информация по срочности
Default
boolean
нет
Признак срочности, используемой по умолчанию true — является видом срочности по умолчанию, false — не является видом срочности по умолчанию

Пример запроса (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>Urgencies</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>Urgencies</m:Key>
        <m:List>
          <m:Key>18c4f207-458b-11dc-9497-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Срочная</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>18c4f208-458b-11dc-9497-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Сверхсрочная</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">Услуга производится по дополнительному согласованию.</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>18c4f209-458b-11dc-9497-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Стандартная</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>9d7b9bdc-772f-11dc-a1ad-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Суточная</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>8bbab642-1df3-11de-bcd5-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Эконом доставка</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string">Услуга доступна для отправлений весом свыше 20 кг</m:Value>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>cf862f56-442d-11dc-9497-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Сборный груз</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Information</m:Key>
            <m:Value xsi:type="xs:string"/>
            <m:ValueType>string</m:ValueType>
          </m:Fields>
          <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>

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

AvailableDeliveryDates

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

BaseUnitsOfMeasurement

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

CargoStates

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