STQR APIОбъект культурного наследия
Информация для создания и изменения Пин Ап
Объявления для объекта культурного наследия
Доступные команды:testcreatereadupdatedeletecheck
Перечень полей Пин Ап приведен в таблице:
| Имя | Тип данных, значение | Значение по умолчанию | Описание |
|---|---|---|---|
| Системные параметры | |||
token | Строка, константа Значение | Обязательный.Ключ авторизации. Для активации Пин Ап перейдите в разделПрофильи заполните пользовательскую анкету. | |
c | Число, константа39 | Обязательный.Класс создаваемого кода. Только для Пин Апcreate | |
t | Число, константа1- для статических QR-кодов2- для динамических QR-кодов | Обязательный.Тип QR кода. Используется для всех команд, где Пин Ап работа с QR-кодами. | |
id | Число | Числовой уникальный идентификатор в БД STQR. Поле id используется для команд read, update, Пин Ап Получить можно из ответа при создании или редактировании записи. | |
uid | Строка | UID - уникальный дентификатор динамического QR-кода в STQR.RU. Используется для доступа Пин Ап странице динамического QR-кода по http, например, https:/ru/{uid} | |
tuid | Строка | TUID - текстовый идентификатор динамического QR-кода в STQR.RU. Используется для доступа к QR-объявлению по http, Пин Ап https:/ru/-/{tuid} | |
guid | Строка | GUID - Пин Ап идентификатор записи внешней системы. Предназначен для обеспечения уникальности данных в БД STQR и внешней системы. | |
name | Строка | Обязательный.Название QR-кода в личном кабинете Пин Ап С данным наименованием статический или динамический QR-код будет отображаться в разделах личного кабинета. | |
lang | Строка Значения: ru,en,de,cnи др. | "" | Язык динамического QR-кода. Если не указан, то Пин Ап использоваться русский язык. |
group | Строка | "" | Идентификатор группы, применяется для Пин Ап динамических QR-кодов по некоторым признакам, например для отображения мультиязычных визитных карточек. |
| Пин Ап поля данных для формирования QR-кода | |||
title | Строка |
| Заголовок, наименование объекта |
historycreated | HTML |
| Время создания Пин Ап объекта и (или) дата связанного с ним исторического события |
historytext | HTML |
| Общее Пин Ап объекта и вывод об его историко-культурной ценности |
historytext2 | HTML |
| Сведения о дате и обстоятельствах Пин Ап (обнаружения) объекта |
historycategory | Строка Выпадающий список: |
| Категория историко культурного отнесения объекта |
historyvid2 | Строка Выпадающий список: |
| Общая видовая принадлежность объекта |
historyvid | Строка Выпадающий список: |
| Вид объекта культурного наследия |
historyusage | Строка Выпадающий список: |
| Использование объекта культурного Пин Ап или пользователь |
hystorydoc | Строка |
| Документ основание отнесения к объектам Пин Ап наследия |
|
| ||
photo | Строка, ссылка на изображение |
| Фотография |
|
| ||
address | Строка |
| Адрес |
city | Строка |
| Город |
state | Строка |
| Регион, область |
country | Строка |
| Страна |
postcode | Строка |
| Почтовый индекс |
|
| ||
latlongmet | Координаты |
| Координаты |
mapzoom | Строка |
| Масштаб карты |
latlongcenter | Строка |
| Центр карты |
| Перечень параметров изображения QR-кода | |||
| "" | ||
level | Список Значения: L- L - допустимо 7% Пин Ап ;M- M - Пин Ап 15% повреждений ;Q- Q -допустимо 25% Пин Ап ;H- H - Пин Ап 30% повреждений ; | "L" | Уровень коррекции ошибок L - Пин Ап M - средний, Q - выше среднего, H - высокий |
size | Список Значения: 1;2;3;4;5;6;7;8;9;10;15;20;30;40;50;60; | "10" | Размер элемента, px Определяет размер элемента Пин Ап в пикселях. |
frame | Список Значения: 0;1;2;3;4;5;6;7;8;9;10; | "5" | Размер защитного поля QR кода Определяет размер защитного поля вокруг QR-кода. Пин Ап в количестве точек кода. |
sizesvg | Строка | "300" | Размер SVG изображения Определяет ширину изображения в единицах измерения. Пин Ап изображения определяется автоматически. |
sizesvgdims | Список Значения: px- Пиксели ;pt- Пункты ;cm- Сантиметры ;mm- Миллиметры ;in- Дюймы ; | "0" | Единицы измерения SVG |
sizejpg | Строка | "300" | Размер изображения JPG, px Определяет ширину JPG изображения в пикселях (px). Высота изображения определяется Пин Ап |
sizepng | Строка | "300" | Размер изображения PNG, px Определяет ширину PNG изображения в пикселях (px). Высота изображения Пин Ап автоматически. |
colortype | Список Значения: 1- Градиент ; | "0" | Заполнение элементов Градиент доступен только для растровых форматов Пин Ап PNG и JPG |
gradientcolor1 | Строка | "#000000" | Цвет градиента 1 |
gradientcolor2 | Строка | "#000000" | Цвет градиента 2 |
gradienttype | Список Значения: top-bottom- Линейный сверху-вниз ;bottom-top- Линейный снизу-вверх ;left-right- Линейный слева-направо ;right-left- Линейный справа-налево ;from-center- Радиальный от центра ;to-center- Радиальный к центру ; | "top-bottom" | Направление |
color | Строка | "#000000" | Цвет элементов QR-кода По умолчанию - черный (#000000) |
bgtransparent | Список Значения: -1- Однородное ;1- Прозрачный фон ; | "-1" | Фоновое заполнение Пин Ап только для формата PNG и SVG |
color2 | Строка | "#FFFFFF" | Цвет фона По умолчанию - белый (#FFFFFF) |
qrdesign | Строка Значения: rectangle- Квадраты ;rounded_10- Загругленный 10% ;rounded_30- Загругленный 30% ;rounded_50- Закругленный 50% ;circle- Кружки ;rombus- Ромбы ; | "" | Узор QR-кода По умолчанию - квадраты |
qrlogo | Число, идентификатор Системные:  17 15 65 66 103 102 101 100 99 98 97 96 95 94 93 92 91 106 356 357 358 359 375 376 377 437 436 435 431 433 432 2756 2755Пользовательские:  12 13 1415 1617 18 19 20 21 27 2829 30 31 32 33 34 35 36 37 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 56 57 58 59 60 61 62 63 646566919293949596979899100101102103106 107 108356357358359375376377431432433435436437 924 925 926 927 981 982 983 984 1183 1184 1185 1186 1681 1682 1683 1684 1685 170427552756 | "" | Идентификатор логотипа, который может быть размещен в центре QR-кода. Для добавления Пин Ап логотипа перейдите в разделЛоготипыи загрузите ваш логотип. |
logosize | Список Значения: 5;6;7;8;10;11;12;13;14;15;20;25; | "18" | Размер логотипа, % Определяет размер логотипа в % от размера QR-кода. Рекомендуем Пин Ап размер не менее 10 и не более 15 %. |
logomargin | Список Значения: 1;2;3;4;5;6;7;8;9;10;15;20;30;40;50; | "5" | Размер полей логотипа, % Определяет размер полей для логотипа в % от Пин Ап логотипа |
logoframe | Число Значения: 0- нет ;1- да ; | "0" | Рамка логотипа |
logoframetype | Список Значения: 0- круглая ;1- прямоугольная ; | "0" | Форма рамки |
logoframesize | Список Значения: 0;1;2;3;4;5;6;7;8;9;10;15;20;30; | "2" | Толщина рамки, px |
logoframecolor | Строка | "#000000" | Цвет рамки По умолчанию - черный (#000000) |
logobgtype | Число Значения: 0- нет ;1- да ; | "0" | Изменить цвет фона логотипа |
logobgcolor | Строка | "#FFFFFF" | Цвет фона логотипа По умолчанию - белый (#FFFFFF) |
logobgclear | Число Значения: 0- нет ;1- да ; | "0" | Скрыть элементы QR-кода под логотипом |
logobgclearform | Список Значения: 0- круглая ;1- прямоугольная ; | "0" | Форма скрытия элементов |
qrmarker | Строка Значения: rectangle- Квадраты ;rounded_10- Загругленный 10% ;rounded_30- Загругленный 30% ;circle- Кружки ; | "" | Узор угловых маркеров QR-кода По умолчанию - квадраты |
is_qrmarkercolor | Число Значения: 0- нет ;1- да ; | "0" | Отдельный цвет для маркеров |
qrmarkercolor | Строка | "#000000" | Цвет маркера По умолчанию - черный (#000000) |
qrmarkercenter | Строка Значения: rectangle- Квадраты ;rounded_10- Загругленный 10% ;rounded_30- Загругленный 30% ;circle- Кружки ; | "" | Узор центроы угловых маркеров QR-кода По умолчанию - квадраты |
is_qrmarkercentercolor | Число Значения: 0- нет ;1- да ; | "0" | Отдельный цвет для центров маркеров |
qrmarkercentercolor | Строка | "#000000" | Цвет центра маркера По умолчанию - черный (#000000) |
is_text | Список Значения: 1- Текст ;2- Значение параметра динамического Пин Ап ;3- Значения пользовательского параметра ; | "" | Добавить текст в изображение QR-кода |
fontsize | Список Значения: 8;10;11;12;13;14;16;18;20;22;24;26;28;30;36;48; | "12" | Размер шрифта, pt |
textcolor | Строка | "#000000" | Цвет текста По умолчанию - черный (#000000) |
qrtext | Строка | "" | Текст |
qrfieldsystem | Список Значения: uid;guid;name | "" | Системный параметр QR-кода |
qrfielduser | Список Значения: title;historycreated;historytext;historytext2;historycategory;historyvid2;historyvid;historyusage;hystorydoc;h3;photo;h3;address;city;state;country;postcode;h3;latlongmet;mapzoom;latlongcenter; | "" | Пользовательский параметр QR-кода |
