Справочник кодов (JV3_ORG_MetaDictionary) - справочник (словарь) метакода.
Справочник позволяет хранить какие-либо кастомные данные, которые пользователь может выбирать из выпадающего списка или вводить в строку. Справочник Справочник содержит коды, характеризуется следующими полями:
...
SequenceNumber (пример: "44") - порядковый номер для отображения в списке при бронировании (обязательное поле, число);
ValidationRegex (пример: "^\d$") - правило валидации кода из справочника (опциональное поле, строка);
ValidationText (пример: "нарушено") - русский текст в случае нарушения валидации (опциональное поле, строка).
ValidationTextLatin (пример: "broken") - английский текст при нарушении валидации (опциональное поле, строка).
Comment (пример: "Комментарий") - комментарий (опциональное поле, строка).
id_BindingType (варианты "0" или "1") - тип привязки справочника:
0 - к командировке;
1 - к заказу.
В интерфейсе список справочников кодов доступен В интерфейсе редактирование справочников доступно в разделе "Настройки > Справочники кодов" всем пользователям - клиенту и агенту (агент должен выбрать договор):
...
", в который агент попадает через раздел "Travel management" в редакторе договоров, а клиент - из меню настроек при условии, что настройка его роли предоставляет ему доступ к редактированию Справочников кодов.
...
Выбираем тип справочника:
...
Открываем нужный справочник из списка:
...
Соответствие полей на интерфейсе полям в базе данных:
...
Для проведения любой операции необходимо пройти авторизациюСоответственно, действие, аналогичное редактированию справочника из API, можно произвести на интерфейсе в разделе “Справочники кодов”.
Перед использованием метода необходимо пройти аутентификацию и получить валидный токен. Подробнее об этом: Авторизация (получение токена)
| Info |
|---|
Для получения контекста справочников используется сервис MetaDictionaryManagement.asmx WSDL можно скачать с демо-сайта: https:// |
...
stage1.corteos.ru/XmlGate/V3/StaticData/MetaDictionary/MetaDictionaryManagement.asmx?wsdl Для работы в продуктовой среде необходимо |
...
заменить “stage1.corteos.ru” на свой домен (на котором работают пользователи вашей компании). |
В API реализованы следующие методы для работы
...
со справочниками кодов:
GetV2 - Получение справочника кодов по получение справочника кодов по первичному ключу (JV3_ORG_MetaDictionary.id_MetaDictionary);
SaveV2 - Сохраняет переданный справочник или создает новый, если id_MetaDictionary == nullсоздание справочника кодов или редактирование существующего;
ListV2 - Получение получение списка справочников кодов для словарягруппы компаний;
DeleteV2 - Удаление справочника кода.
Разберем эти методы более подробно.
1. Запрос на получение одного справочника кодов (GetV2)
удаление справочника кодов по первичному ключу.
Подробное описание методов с примерами:
Получение справочника кодов по первичному ключу (GetV2)
Для проведения выгрузки данных, необходимо передать первичный ключ справочника (id_MetaDictionary).
Создание
...
справочника кодов или редактирование существующего (SaveV2)
Для сохранения изменений в уже созданном справочнике необходимо передать первичный ключ справочника .
В том случае, если мы создаем новый справочник, первичный ключ не передаем.
Если нам надо удалить справочника, то в атрибуте deleted передаем значение true.
Запрос на создание / Запрос на редактирование / Ответ3.
Получение списка справочников кодов группы компаний (ListV2)
Для получения списка справочников внутри группы компаний используется метод ListV2
Запрос на удаление
...
справочника кода (DeleteV2)
Для удаления справочника по первичному ключу (id_MetaDictionary) используется метод DeleteV2.