GetReferenceData: Services — Услуги | КСЭ Документация API

Try it — Services

SOAP Request

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

Response

GetReferenceData: Services — Услуги

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

Endpoint: GetReferenceData
Soap-method: Services

Описание

Функция позволяет получить список оказываемых услуг, необходимых для использования в других функциях при вызове 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>Services</car:Value>
   <car:ValueType>string</car:ValueType>
</car:List>

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

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

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

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

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

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

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

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

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

Каждый блок List описывает одну доступную услугу и содержит в себе:

Key: уникальный идентификатор услуги (например, f2bab0b0-4317-11e0-9c27-00237dd28494);
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 содержит набор расширенных характеристик, описывающие свойства услуги:

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

Параметр	Тип	Обязательно	Описание
Default	boolean		Признак услуги, используемой по умолчанию. Указывает, включается ли услуга автоматически при создании заказа. true - услуга добавляется в заказ автоматически; false- услуга добавляется только по запросу клиента.
AdditionalService	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>Services</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>Services</m:Key>
        <m:List>
          <m:Key>f2bab0b0-4317-11e0-9c27-00237dd28494</m:Key>
          <m:Value xsi:type="xs:string">Доупаковка</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>6da21fe8-4f13-11dc-bda1-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Россия доставка</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>5a8ec125-92ac-11dc-86de-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Московская обл.</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>9c03a8ae-0d23-11ef-86c1-005056bbb928</m:Key>
          <m:Value xsi:type="xs:string">Частичный выкуп</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>cc03d9ad-61f4-11dc-bda1-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Страхование</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>6da21fe7-4f13-11dc-bda1-0015170f8c09</m:Key>
          <m:Value xsi:type="xs:string">Объявленная стоимость</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>7ad2661d-bfcd-11df-9948-00237dd28494</m:Key>
          <m:Value xsi:type="xs:string">Возврат документов</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>a4be6874-fd9f-11ef-8690-c036a556d77b</m:Key>
          <m:Value xsi:type="xs:string">Возврат при доставке</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>ed1f8c46-fd8a-11ef-8690-005056a355e0</m:Key>
          <m:Value xsi:type="xs:string">Возврат сопроводительных документов</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>0c837e6d-2037-11e3-a12e-001e670c26ac</m:Key>
          <m:Value xsi:type="xs:string">Обрешетка</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>Default</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
          <m:Fields>
            <m:Key>AdditionalService</m:Key>
            <m:Value xsi:type="xs:boolean">true</m:Value>
            <m:ValueType>boolean</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>