Try it — Подразделения - PutReferenceData

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

PutReferenceData: Создание/изменение подразделений клиента

  • Создано 16.04.2026
  • Обновлено 19.05.2026
  • Endpoint: PutReferenceData
  • Soap-method: Подразделения - PutReferenceData
Описание

Функция позволяет создавать новые подразделения клиента либо изменять имеющиеся. 

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

Параметры справочника содержит Key = "parameters" и элементы List

Описание: Параметры справочника, в который добавляются/обновляются элементы. Каждый параметр представлен отдельным блоком List, содержащим:

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

Таблица параметров (возможные значения Key внутри List):

Параметр Тип Обязательно Описание
Reference string Имя справочника (например, Departments — подразделения)
Описание параметра data

Содержит список данных о проекте. Содержит Key = "elements"  и список элементов List

List содержит данные об одном элементе справочника 

  • Key — Наименование подразделения клиента (обязательно)
  • Value — GUID элемента. Если заполнено значение, то данный элемент будет изменен.
  • Fields — Передаваемые параметры обновления.

Описание вложенного параметра Fields. Каждый параметр представлен отдельным блоком Fields, содержащим:

  • Key — название параметра (варианты в таблице ниже)
  • Value — значение этого параметра
  • ValueType — тип значения этого параметра

Таблица параметров (возможные значения Key для Fields):

Параметр Тип Обязательно Описание
DontUse boolean Признак что данное подразделение временно не используется.
DeletionMark boolean Пометка удаления указанного подразделения.
Описание возвращаемого параметра return

Содержит пару параметров Key и List содержащие ответ по одному элементу

Структура List  группирует результат по одному элементу:

  • Key — название параметра
  • Value — результат изменения
  • ValueType — тип значения этого параметра

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

Параметр Тип Обязательно Описание
Примеры запроса/ответа
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:ns1="http://www.cargo3.ru">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns1:PutReferenceData>
      <ns1:login>test</ns1:login>
      <ns1:password>2016</ns1:password>
      <ns1:data>
        <ns1:Key>elements</ns1:Key>
        <ns1:List>
          <ns1:Key>Проверка создания по апи</ns1:Key>
          <ns1:Value></ns1:Value>
          <ns1:Fields>
            <ns1:Key>DontUse</ns1:Key>
            <ns1:Value>false</ns1:Value>
            <ns1:ValueType>bolean</ns1:ValueType>
          </ns1:Fields>
          <ns1:Fields>
            <ns1:Key>DeletionMark</ns1:Key>
            <ns1:Value>false</ns1:Value>
            <ns1:ValueType>bolean</ns1:ValueType>
          </ns1:Fields>
        </ns1:List>
        <ns1:List>
          <ns1:Key>Новое название</ns1:Key>
          <ns1:Value>fc00c721-3510-11e9-911f-005056b1a128</ns1:Value>
          <ns1:Fields>
            <ns1:Key>DontUse</ns1:Key>
            <ns1:Value>false</ns1:Value>
            <ns1:ValueType>bolean</ns1:ValueType>
          </ns1:Fields>
          <ns1:Fields>
            <ns1:Key>DeletionMark</ns1:Key>
            <ns1:Value>false</ns1:Value>
            <ns1:ValueType>bolean</ns1:ValueType>
          </ns1:Fields>
        </ns1:List>
      </ns1:data>
      <ns1:parameters>
        <ns1:Key>parameters</ns1:Key>
        <ns1:List>
          <ns1:Key>Reference</ns1:Key>
          <ns1:Value>Departments</ns1:Value>
          <ns1:ValueType>string</ns1:ValueType>
        </ns1:List>
      </ns1:parameters>
    </ns1:PutReferenceData>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
<soap:Envelope
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <m:PutReferenceDataResponse
      xmlns:m="http://www.cargo3.ru">
      <m:return xsi:type="m:Element"
        xmlns:xs="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
        <m:Key>Departments</m:Key>
        <m:List>
          <m:Key>b96c6579-35eb-11e9-911f-005056b1a128</m:Key>
          <m:Value xsi:type="xs:string">OK</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
        <m:List>
          <m:Key>fc00c721-3510-11e9-911f-005056b1a128</m:Key>
          <m:Value xsi:type="xs:string">OK</m:Value>
          <m:ValueType>string</m:ValueType>
        </m:List>
      </m:return>
    </m:PutReferenceDataResponse>
  </soap:Body>
</soap:Envelope>