GetReferenceData: Projects — Проекты

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

Endpoint: GetReferenceData
SOAP-метод: Projects
Группа: GetReferenceData
Создано: 16.04.2026 · Обновлено: 18.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>Projects</car:Value>
 <car:ValueType>string</car:ValueType>
</car:List>

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

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

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

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

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

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

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

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

List: контейнер записи справочника.

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

Key: Уникальный идентификатор проекта (GUID) (например, 0837e701-01f4-11ea-9985-005056bb6b60);
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, и т.д.).

Параметр	Тип	Обязательно	Описание
DeletionMark	boolean	нет	Признак того, что в системе «Карго» проект помечен на удаление (как неиспользуемый, или устаревший). true — проект удалён (неактивен), false — активен
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>Projects</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>Projects</m:Key>
        <m:List>
          <m:Key>0837e701-01f4-11ea-9985-005056bb6b60</m:Key>
          <m:Value xsi:type="xs:string"/>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>DeletionMark</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</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>3c60dc95-da1c-11ee-86c1-005056bbb928</m:Key>
          <m:Value xsi:type="xs:string">-</m:Value>
          <m:ValueType>string</m:ValueType>
          <m:Fields>
            <m:Key>DeletionMark</m:Key>
            <m:Value xsi:type="xs:boolean">false</m:Value>
            <m:ValueType>boolean</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

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