Метакод (JV3_ORG_MetaCode)

Метакод (JV3_ORG_MetaCode) - объект для метакода, который привязывается к словарю, содержит кастомные пользовательские данные, характеризуется следующими полями:

id_MetaCode (пример: "123") - первичный ключ метакода (обязательное поле, число).
Если мы создаем новый метакод, то значение не передаем, если редактируем существующий - передаем идентификатор;
Name (пример: "Тестовый код") - название кода, понятное пользователю (обязательное поле, строка);
NameLatin (пример: "Test Code") - название кода на английском, понятное пользователю (обязательное поле, строка);
Tag (пример: "my-tag") - служебный тэг, описывает поведение кода (необязательное поле, строка);
CodeValue (пример: "value") - служебное значение кода, может быть подвергнуто валидации с помощью поля ValidationRegex в справочнике кодов (обязательное поле, строка);
id_MetaDictionary (пример: "123") - ссылка на справочник кодов (обязательное поле, число).

Под агентом: в интерфейсе редактирование контактов доступно в разделе "Справочники кодов", куда можно попасть через раздел "Travel management" в редакторе договоров.

Под клиентом: следует зайти в меню "Настройки > Справочники кодов".

Переходим к любому типу справочника:

По умолчанию попадаем на вкладку "Детали", потом выбираем вкладку "Коды справочника"

Из списка выбираем для редактирования любой код:

Соответствие полей интерфейса полям модели:

Для проведения любой операции необходимо пройти авторизацию, а также, если мы работаем от имени агента, получить контекст клиента

WSDL можно скачать с демо-сайта: https://demo.corteos.ru/XmlGate/V3/StaticData/MetaCode/MetaCodeManagement.asmx?wsdl

Для работы в продуктовой среде необходимо заменить demo.corteos.ru на свой домен (на котором работают пользователи вашей компании).

В API реализованы следующие методы для работы с метакодом:

GetV2 - Получение кода по первичному ключу (JV3_ORG_MetaCode.id_MetaCode);
SaveV2 - Сохраняет переданный метакод или создает новый, если id_MetaCode == null;
ListV2 - Получение списка кодов для словаря;
DeleteV2 - Удаление кода.

Разберем эти методы более подробно.

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

создание нового кода - запрос / ответ
редактирование существующего кода - запрос / ответ совпадает с ответом "создание нового кода"
получить код по первичному ключу(id_MetaCode) - запрос / ответ
получить все мета коды - запрос / ответ
удалить метакод с переданным первичным ключом - запрос / ответ

После обновления 03/09/24 доработан метод ListV2:

Теперь по умолчанию метод ListV2 даёт в ответе до 2000 значений справочника (ранее было 100), а так же добавили дополнительные не обязательные параметры запроса.

Теперь запрос выглядит так:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:cor="http://corteos.ru">
   <soap:Header>
      <cor:AuthHeader>
         <!--Optional:-->
         <cor:Token>?</cor:Token>
      </cor:AuthHeader>
   </soap:Header>
   <soap:Body>
      <cor:ListV2>
         <cor:id_MetaDictionary>?</cor:id_MetaDictionary>
         <!--Optional:-->
         <cor:namePart>?</cor:namePart>
         <cor:Skip>?</cor:Skip>
         <cor:Take>?</cor:Take>
      </cor:ListV2>
   </soap:Body>
</soap:Envelope>

namePart отвечает за поиск в справочнике значений совпадающих с ключом указанном в запросе. К примеру при указании “авто”, то будут найдены значения: “автомобиль”, “автопоезд”, “автомат” и т.д., т.е. все значения где в в названии CodeValue значения справочника есть указанный ключ.

Take данный параметр может использоваться для увеличения количества выдаваемых значений справочника с 2000 до 10000 (макс), а так же может быть использован в связке с параметром Skip

Примеры:

<cor:Skip>0</cor:Skip>
<cor:Take>5</cor:Take>

При указании параметров Skip 0 и Take 5 система покажет в ответе 5 первых значений справочника.

<cor:Skip>5</cor:Skip>
<cor:Take>10</cor:Take>

При указании параметров Skip 5 и Take 10 система покажет в ответе 10 значений справочника которые идут после 5, т.е. с 6 по 15 значение.

____