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

Owned by Anna Gorovaya (Unlicensed)
Last updated: Mar 05, 2023 by Confluence Admin
2 min read

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

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



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

  • 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 - к заказу.

В интерфейсе список справочников кодов доступен в разделе "Настройки > Справочники кодов" всем пользователям - клиенту и агенту (агент должен выбрать договор):

 

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

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

 

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

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

 

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

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

  2. SaveV2 - Сохраняет переданный справочник или создает новый, если id_MetaDictionary == null;

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

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

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

1. Запрос на получение одного справочника кодов (GetV2)

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

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

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

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

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

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