GetReferenceData: AvailableTakeDates — Возможные даты забора

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

SOAP Endpoint: GetReferenceData Обновлено: 2026-07-11
  • Endpoint: GetReferenceData
  • SOAP-метод: AvailableTakeDates
  • Группа: GetReferenceData
  • Создано: 16.04.2026 · Обновлено: 11.07.2026

Описание

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

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

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

Параметр
Тип
Обязательно
Описание
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>availabletakedates</car:Value>
   <car:ValueType>string</car:ValueType>
</car:List>

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

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

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

Параметр
Тип
Обязательно
Описание
Reference
string
Да
Имя справочника, должно быть равно «availabletakedates».
Geography
string
Да
Поиск по одному из параметров:
1. GUID (Globally Unique Identifier) географии отправления (получение объектов географии см. https://cse-dev-portal.bxb.delivery/site/method?slug=getreferencedata-geography), или код географии клиента, если клиент пользуется собственной географией.
2. Код ФИАС, для этого необходимо передать строку «fias-» и необходимый код ФИАС.
3. Индекс, необходимо указать префикс «postcode-», затем код страны (цифровой, либо Альфа-2, либо Альфа-3) и индекс для поиска.
Пример «postcodeKZA00A0A0». Если код страны не вводится, то по умолчанию поиск осуществляется по России. Пример для России: «postcode-RU-990500» или «postcode-990500» (данный вариант поиска может возвращать не точную информацию).
other
string
Да
GUID срочности (см. https://cse-dev-portal.bxb.delivery/site/method?slug=getreferencedata-urgencies).
takedate
Datetime
Нет
Предполагаемая дата забора груза, для получения расчетной плановой даты доставки. По умолчанию расчет от текущей даты и дата забора груза возвращается в часовом поясе географии отправителя.

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

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

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

Key: строка со значением ListOfAvailableTakeDates;

List: массив элементов, каждый из которых содержит информацию о доступной дате забора.

Каждый элемент из списка List  содержит в себе:

  • Key: значение TakeDates;
  • Properties: массив временных интервалов для данной даты (может отсутствовать или быть несколько);
  • Fields: содержит непосредственно дату забора.

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

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

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

Параметр
Тип
Обязательно
Описание
Key
string
Да
Наименование списка дат забора
List
Element
Да
Список возможных дат забора

Описание возможных возвращаемых параметров Properties

Блок Properties содержит в себе один временной интервал забора груза, доступный для выбора в указанную дату,  и состоит из элементов: 

  • Key: значение Interval;
  • Fields: содержит время начала или окончания интервала.
Параметр
Тип
Обязательно
Описание
TimeFrom
dateTime
Нет
Время начала работы в формате HH:MM:SS (без даты).
TimeTo
dateTime
Нет
Время окончания работы в формате HH:MM:SS (без даты).

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

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

  • Key: идентификатор признака (TakeDate);
  • Value: значение признака;
  • ValueType: тип значения — строка, указывающая тип Value (datetime и т.п.).
Параметр
Тип
Обязательно
Описание
TakeDate
dateTime
Нет
Календарная дата забора груза

Пример запроса (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>availabletakedates</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>Geography</car:Key>
          <car:Value>cf862f56-442d-11dc-9497-0015170f8c09</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>other</car:Key>
          <car:Value>18c4f207-458b-11dc-9497-0015170f8c09</car:Value>
          <car:ValueType>string</car:ValueType>
        </car:List>
        <car:List>
          <car:Key>takedate</car:Key>
          <car:Value>2025-01-28T00:00:00</car:Value>
          <car:ValueType>dateTime</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>ListOfAvailableTakeDates</m:Key>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-10</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-13</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-14</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">14:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">12:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-15</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-16</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-17</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-20</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-21</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">14:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">12:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-22</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
        <m:List>
          <m:Key>TakeDates</m:Key>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">00:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">09:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Properties>
            <m:Key>Interval</m:Key>
            <m:Fields>
              <m:Key>TimeFrom</m:Key>
              <m:Value xsi:type="xs:time">18:00:00</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
            <m:Fields>
              <m:Key>TimeTo</m:Key>
              <m:Value xsi:type="xs:time">23:59:59</m:Value>
              <m:ValueType>dateTime</m:ValueType>
            </m:Fields>
          </m:Properties>
          <m:Fields>
            <m:Key>TakeDate</m:Key>
            <m:Value xsi:type="xs:date">2026-07-23</m:Value>
            <m:ValueType>dateTime</m:ValueType>
          </m:Fields>
        </m:List>
      </m:return>
    </m:GetReferenceDataResponse>
  </soap:Body>
</soap:Envelope>