Справочник кодов (JV3_ORG_MetaDictionary)

Справочник кодов (JV3_ORG_MetaDictionary) - справочник (словарь) метакода.

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

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

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

  • 1 - Budget - Справочник Бюджетные коды

  • 2 - StructuralPersonal - Справочник Привязанные к персонам структурные коды

  • 3 - PolicyRulesAttached - Справочник Привязанные к нарушениям политики коды

  • 4 - ChangeableStructuralPersonal - Справочник Структурные меняемые коды

  • 5 - TravelPolicyViolationBudget - Справочник Коды нарушения тревел-политики

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

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

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

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

• id_Group (пример: "123") - указание, к какой группе компаний привязан справочник (FK ORG_Group) (обязательное поле, число);

• SelectorMode (пример: "2") -  способ выбора кода из данного справочника (ввод вручную, автокомплит, выбор из списка) (обязательное поле, число):

  • 1 - TextBox - Текстовое поле;

  • 2 - Dropdown - Выпадающий список;

  • 3 - Autocomplete - Автозавершение.

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

• ValidationRegex (пример: "^\d$") - правило валидации кода из справочника (опциональное поле, строка);

• ValidationText (пример: "нарушено") - русский текст в случае нарушения валидации (опциональное поле, строка).

• ValidationTextLatin (пример:  "broken") - английский текст при нарушении валидации (опциональное поле, строка).

• Comment (пример: "Комментарий") - комментарий (опциональное поле, строка).

• id_BindingType (варианты "0" или "1") - тип привязки справочника:

  • 0 - к командировке;

  • 1 - к заказу.

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

Open

Выбираем тип справочника:

Open

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

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

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

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

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

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

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

3. ListV2 - получение списка справочников кодов группы компаний;

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

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

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

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

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

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

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

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

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

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

3. Получение списка справочников кодов группы компаний (ListV2)

Для получения списка справочников внутри группы компаний используется метод ListV2

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

4. Запрос на удаление справочника кода (DeleteV2)

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

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