GetReferenceData: Settings — Настройки пользователя

Try it — Settings

SOAP Request

Отредактируйте параметры запроса и нажмите Выполнить для отправки запроса на сервер

Response

GetReferenceData: Settings — Настройки пользователя

Создано 16.04.2026
Обновлено 19.05.2026

Endpoint: GetReferenceData
Soap-method: Settings

Описание

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметр Element в ответе содержит информацию о системных настройках и параметрах конфигурации для работы с API.

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

Key: идентификатор справочника, строка со значением Settings;

Fields: массив элементов справочника.

Каждый блок Fields описывает один параметр конфигурации и содержит в себе:

Key: наименование поля (например, Agent);
Value: значение поля;
ValueType: тип значения — строка, указывающая тип Value (string, boolean, float и т.п.);

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

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

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

Параметр	Тип	Описание
Agent	boolean	Признак, что клиент является агентом. true - клиент является агентом; false - клиент не является агентом.
DimensionalWeightFactor	boolean	Коэффициент для расчета объемного веса
WeightLimit	float	Лимит веса, кг (если 0, то лимит веса не ограничен)
InsuranceLimit	float	Ограничение по страховой стоимости
DeclaredLimit	float	Ограничение по объявленной стоимости
Store	string	GUID основного склада клиента
UseOwnCodeState	boolean	Признак того, что клиент имеет свои собственные коды статусов. true - можно использовать собственные коды статусов; false - используются только системные статусы.

Примеры запроса/ответа

XML Request
XML Response

<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>settings</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>Settings</m:Key>
        <m:Fields>
          <m:Key>Agent</m:Key>
          <m:Value xsi:type="xs:boolean">false</m:Value>
          <m:ValueType>boolean</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>DimensionalWeightFactor</m:Key>
          <m:Value xsi:type="xs:decimal">5000</m:Value>
          <m:ValueType>float</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>WeightLimit</m:Key>
          <m:Value xsi:type="xs:decimal">0</m:Value>
          <m:ValueType>float</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>InsuranceLimit</m:Key>
          <m:Value xsi:type="xs:decimal">4500000</m:Value>
          <m:ValueType>float</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>DeclaredLimit</m:Key>
          <m:Value xsi:type="xs:decimal">4000000</m:Value>
          <m:ValueType>float</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>Store</m:Key>
          <m:Value xsi:type="xs:string">7538ab2d-70b5-11e0-8bb9-001e67086478</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:Fields>
        <m:Fields>
          <m:Key>UseOwnCodeState</m:Key>
          <m:Value xsi:type="xs:boolean">false</m:Value>
          <m:ValueType>boolean</m:ValueType>
        </m:Fields>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>