Метакод (JV3_ORG_MetaCode)

Owned by Corteos Platform (Unlicensed)
Last updated: Jul 31, 2024 by Виктория
3 min read

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

  • id_MetaCode (пример: "123") - первичный ключ метакода (обязательное поле, число). Если мы создаем новый метакод, то значение не передаем, если редактируем существующий - передаем идентификатор;

  • Name (пример: "Тестовый код") - название кода, понятное пользователю (обязательное поле, строка);

  • NameLatin (пример: "Test Code") - название кода на английском, понятное пользователю (обязательное поле, строка);

  • Tag (пример: "my-tag") - служебный тэг, описывает поведение кода (необязательное поле, строка);

  • CodeValue (пример: "value") - служебное значение кода, может быть подвергнуто валидации с помощью поля ValidationRegex в справочнике кодов (обязательное поле, строка);

  • id_MetaDictionary (пример: "123") - ссылка на справочник кодов (обязательное поле, число).

В интерфейсе редактирование кодов доступно в разделе "Справочники кодов", в который агент попадает через раздел "Travel management" в редакторе договоров, а клиент - из меню настроек при условии, что настройка его роли предоставляет ему доступ к редактированию Справочников кодов.

image-20240508-104848.png

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

image-20240508-105137.png

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

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


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


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

Соответственно, действие, аналогичное редактированию кодов справочника из API, можно произвести на интерфейсе в разделе “Справочники кодов”.

Перед использованием метода необходимо пройти аутентификацию и получить валидный токен. Подробнее об этом: Авторизация (получение токена)

Для получения контекста метакода используется сервис MetaCodeManagement.asmx

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

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

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

  1. GetV2 - получение кода по первичному ключу (JV3_ORG_MetaCode.id_MetaCode);

  2. SaveV2 - создание нового кода или редактирование существующего;

  3. ListV2 - получение списка кодов для словаря (справочника);

  4. DeleteV2 - удаление кода по первичному ключу.

Подробное описание методов с примерами:

  1. Получение кода по первичному ключу (GetV2)

Для проведения выгрузки данных, необходимо передать первичный ключ кода (id_MetaCode).

Запрос / Ответ

  1. Создание нового кода или редактирование существующего (SaveV2)

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

В том случае, если мы создаем новый код, первичный ключ не передаем.

Если нам надо удалить код, то в атрибуте deleted передаем значение true.

Запрос на создание / Запрос на обновление / Ответ

  1. Получение списка кодов для словаря (справочника) (ListV2)

Получить список кодов можно по идентификатору справочника (id_MetaDictionary), которому эти коды принадлежат. Данный параметр является обязательным.

Запрос / Ответ

  1. Удаление кода по первичному ключу (DeleteV2)

Для удаления кода по первичному ключу используется метод DeleteV2.

Запрос / Ответ