API (КУС) — различия между версиями
м |
м (→НазначитьУслуги) |
||
(не показаны 22 промежуточные версии 2 участников) | |||
Строка 1: | Строка 1: | ||
<noinclude>[[Категория: API (Кинт)|К]] | <noinclude>[[Категория: API (Кинт)|К]] | ||
− | [[Категория: | + | [[Категория: Интеграция с внешними сервисами (КУС)]]</noinclude> |
{| align="right" | {| align="right" | ||
| __TOC__ | | __TOC__ | ||
Строка 2883: | Строка 2883: | ||
"Result": true, | "Result": true, | ||
"Messages": [] | "Messages": [] | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | ==== ДоступноеВремяСеансов==== | ||
+ | * '''Тип HTTP-запроса''': GET | ||
+ | * '''Описание''': Получение свободных сеансов для назначения | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |+Параметры | ||
+ | !|Наименование | ||
+ | !|Обязателен? | ||
+ | !|Тип данных | ||
+ | !|Описание | ||
+ | !|Пример | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Оборудование</code> | ||
+ | |Нет | ||
+ | |<code>Справочник.Номенклатура</code> | ||
+ | |Отбор по оборудованию. | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Номенклатура?ref=b87a60a44c379a5b11e84226f79ecc90"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Кабинет</code> | ||
+ | |Нет | ||
+ | |<code>Справочник.Помещения</code> | ||
+ | |Отбор по кабинету. | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6771c76040"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Услуга</code> | ||
+ | |Нет | ||
+ | |<code>Справочник.Услуги</code> | ||
+ | |Отбор по услугам. | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>ПараметрыНазначения</code> | ||
+ | |Нет | ||
+ | |<code>Справочник.яъЗначенияСвойств</code> | ||
+ | |Отбор по параметрам назначения. | ||
+ | |<code>{"ID": "e1cib/data/Документ.яъЗначенияСвойств?ref=9a58f2e8cf1cc29211ea9e62826f7645"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>фПлатная</code> | ||
+ | |Нет | ||
+ | |<code>Булево</code> | ||
+ | |Отбор по платности сеанса | ||
+ | |<code>Ложь</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>фСрочная</code> | ||
+ | |Нет | ||
+ | |<code>Булево</code> | ||
+ | |Отбор по срочности сеанса | ||
+ | |<code>Ложь</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Пол</code> | ||
+ | |Нет | ||
+ | |<code>Строка</code> | ||
+ | |Отбор по полу сеанса | ||
+ | |<code>"Перечисления.яъПол.Мужской", "Перечисления.яъПол.Женский"</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>ПриоритетПодбора</code> | ||
+ | |Нет | ||
+ | |<code>Справочник.Приоритеты</code> | ||
+ | |Используемый приоритет подбора | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Приоритеты?ref=b20b6451060d98bd11e5be9bf893b2c4"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>НачалоПериода</code> | ||
+ | |Нет | ||
+ | |<code>Дата</code> | ||
+ | |Отбор по периоду | ||
+ | |<code>"2023-03-18T00:00:00"</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>КонецПериода</code> | ||
+ | |Нет | ||
+ | |<code>Дата</code> | ||
+ | |Отбор по периоду | ||
+ | |<code>"2023-03-19T00:00:00"</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>КартаГостя</code> | ||
+ | |Нет | ||
+ | |<code>Документ.КартаГостя</code> | ||
+ | |Учитывается занятость пациента. Если у пациента назначен сеанс в период свободного сеанса, то такой сеанс стаёт недоступен. | ||
+ | |<code>{"ID": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc22a22d2dea3"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |} | ||
+ | |||
+ | ;Пример запроса: | ||
+ | <pre class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;"> | ||
+ | /hs/KintAPI.hs/GetData?Method=ДоступноеВремяСеансов&Кабинет={"Идентификатор": "e1cib/data/Справочник.Помещения?ref=9cb960a44c379a5b11e76c836b4f3c80"}&Оборудование={"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=b20b6451060d98bd11e58f79a6505d1b"}&Услуга={"Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0512b29070"}&ПараметрыНазначения={"Идентификатор": "e1cib/data/Документ.яъЗначенияСвойств?ref=00000000000000000000000000000000"}&НачалоПериода=20241228111914&КонецПериода=20241229000000&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=96f2708bcda2156111efbb97ea88dd5c"}&фПлатная=false&фСрочная=false | ||
+ | </pre> | ||
+ | |||
+ | ==== ОтменитьСеанс==== | ||
+ | * '''Тип HTTP-запроса''': POST | ||
+ | * '''Описание''': Создание документа [[Документ "Отмена назначений услуг" (КУС)|«Отмена назначений услуг»]] и заполнение его реквизитов. Данные заполнения следует брать из результата метода [[API (КУС)#НазначенияИРезультаты|НазначенияИРезультаты]]. | ||
+ | |||
+ | ;Пример запроса: | ||
+ | <pre class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;"> | ||
+ | { | ||
+ | "КартаГостя": { | ||
+ | "Идентификатор": "e1cib/data/Документ.КартаГостя?ref=96f2708bcda2156111efbb97ea88dd5c" | ||
+ | }, | ||
+ | "Пациент": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=bf605404a66e4a8911e51fc2ed922277" | ||
+ | }, | ||
+ | "Врач": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=9bac60a44c379a5b11e70a53879722bf" | ||
+ | }, | ||
+ | "ДатаНачала": "2024-12-16T00:00:00", | ||
+ | "ДатаОкончания": "2024-12-29T00:00:00", | ||
+ | "Услуга": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0512b29070" | ||
+ | }, | ||
+ | "мсОтменяемыеСеансы": [ | ||
+ | { | ||
+ | "Услуга": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0512b29070" | ||
+ | }, | ||
+ | "ДатаСеанса": "2024-12-28T00:00:00", | ||
+ | "ВремяС": "0001-01-01T13:00:00", | ||
+ | "ВремяДо": "0001-01-01T14:00:00", | ||
+ | "ПараметрыНазначения": { | ||
+ | "Идентификатор": "e1cib/data/Документ.яъЗначенияСвойств?ref=00000000000000000000000000000000" | ||
+ | }, | ||
+ | "Кабинет": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Помещения?ref=9cb960a44c379a5b11e76c836b4f3c80" | ||
+ | }, | ||
+ | "Оборудование": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=b20b6451060d98bd11e58f79a6505d1b" | ||
+ | }, | ||
+ | "КартаГостя": { | ||
+ | "Идентификатор": "e1cib/data/Документ.КартаГостя?ref=96f2708bcda2156111efbb97ea88dd5c" | ||
+ | }, | ||
+ | "ДокументНазначения": { | ||
+ | "Идентификатор": "e1cib/data/Документ.НазначениеУслуг?ref=96f2708bcda2156111efbb9b061d4e53" | ||
+ | }, | ||
+ | "Срочная": false, | ||
+ | "КодСтроки": 73, | ||
+ | "ДокументРезультат": null, | ||
+ | "ПроцентОплаты": 0, | ||
+ | "Пройдено": 0, | ||
+ | "Исполнитель": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=00000000000000000000000000000000" | ||
+ | }, | ||
+ | "БлижайшийСеанс": "2024-12-16T00:00:00", | ||
+ | "Осталось": 1, | ||
+ | "Назначено": 0, | ||
+ | "Пациент": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=bf605404a66e4a8911e51fc2ed922277" | ||
+ | }, | ||
+ | "фПройден": false, | ||
+ | "фПлатная": false | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | ;Пример ответа: | ||
+ | <pre> | ||
+ | true | ||
+ | </pre> | ||
+ | |||
+ | ==== ПеренестиСеанс==== | ||
+ | * '''Тип HTTP-запроса''': POST | ||
+ | * '''Описание''': Создание документа [[Документ "Перенос услуг" (КУС)|«Перенос услуг»]] и заполнение его реквизитов. Данные заполнения следует брать из результата метода [[API (КУС)#НазначенияИРезультаты|НазначенияИРезультаты]]. | ||
+ | |||
+ | ;Пример запроса: | ||
+ | <pre class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;"> | ||
+ | { | ||
+ | "стСтарыйСеанс": { | ||
+ | "Услуга": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70" | ||
+ | }, | ||
+ | "ДатаСеанса": "2025-02-01T00:00:00", | ||
+ | "ВремяС": "0001-01-01T08:30:00", | ||
+ | "ВремяДо": "0001-01-01T09:00:00", | ||
+ | "ПараметрыНазначения": { | ||
+ | "Идентификатор": "e1cib/data/Документ.яъЗначенияСвойств?ref=00000000000000000000000000000000" | ||
+ | }, | ||
+ | "Кабинет": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6771c76040" | ||
+ | }, | ||
+ | "Оборудование": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=b20b6451060d98bd11e58e90c8070481" | ||
+ | }, | ||
+ | "КартаГостя": { | ||
+ | "Идентификатор": "e1cib/data/Документ.КартаГостя?ref=96f4708bcda2156111efdd5efa32b54f" | ||
+ | }, | ||
+ | "ДокументНазначения": { | ||
+ | "Идентификатор": "e1cib/data/Документ.НазначениеУслуг?ref=96f4708bcda2156111efdd643800be4b" | ||
+ | }, | ||
+ | "КодСтроки": 72, | ||
+ | "ДокументРезультат": null, | ||
+ | "Корпус": "корпус Лечебный, 2 этаж", | ||
+ | "ПроцентОплаты": 0, | ||
+ | "Пройдено": 0, | ||
+ | "Исполнитель": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=00000000000000000000000000000000" | ||
+ | }, | ||
+ | "БлижайшийСеанс": "2025-01-28T00:00:00", | ||
+ | "Осталось": 1, | ||
+ | "Назначено": 0, | ||
+ | "Пациент": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=bf605404a66e4a8911e51fc2ed922277" | ||
+ | }, | ||
+ | "ПредставлениеПараметровНазначения": "", | ||
+ | "фПройден": false, | ||
+ | "фСрочная": false, | ||
+ | "фПлатная": false, | ||
+ | "КоличествоМест": 1 | ||
+ | }, | ||
+ | "стНовыйСеанс": { | ||
+ | "Услуга": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70" | ||
+ | }, | ||
+ | "ДатаСеанса": "2025-02-01T00:00:00", | ||
+ | "ВремяС": "0001-01-01T10:30:00", | ||
+ | "ВремяДо": "0001-01-01T11:00:00", | ||
+ | "ПараметрыНазначения": { | ||
+ | "Идентификатор": "e1cib/data/Документ.яъЗначенияСвойств?ref=00000000000000000000000000000000" | ||
+ | }, | ||
+ | "Кабинет": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6771c76040" | ||
+ | }, | ||
+ | "Оборудование": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=b20b6451060d98bd11e58e90c8070481" | ||
+ | }, | ||
+ | "КартаГостя": { | ||
+ | "Идентификатор": "e1cib/data/Документ.КартаГостя?ref=96f4708bcda2156111efdd5efa32b54f" | ||
+ | }, | ||
+ | "ДокументНазначения": { | ||
+ | "Идентификатор": "e1cib/data/Документ.НазначениеУслуг?ref=96f4708bcda2156111efdd643800be4b" | ||
+ | }, | ||
+ | "КодСтроки": 72, | ||
+ | "ДокументРезультат": null, | ||
+ | "Корпус": "корпус Лечебный, 2 этаж", | ||
+ | "ПроцентОплаты": 0, | ||
+ | "Пройдено": 0, | ||
+ | "Исполнитель": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=00000000000000000000000000000000" | ||
+ | }, | ||
+ | "БлижайшийСеанс": "2025-01-28T00:00:00", | ||
+ | "Осталось": 1, | ||
+ | "Назначено": 0, | ||
+ | "Пациент": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=bf605404a66e4a8911e51fc2ed922277" | ||
+ | }, | ||
+ | "ПредставлениеПараметровНазначения": "", | ||
+ | "фПройден": false, | ||
+ | "фСрочная": false, | ||
+ | "фПлатная": false, | ||
+ | "КоличествоМест": 1 | ||
+ | } | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | ;Пример ответа: | ||
+ | <pre> | ||
+ | true | ||
+ | </pre> | ||
+ | |||
+ | ==== НазначитьУслуги ==== | ||
+ | * '''Тип HTTP-запроса''': POST | ||
+ | * '''Описание''': Создание [[Документ "Назначение услуг" (КУС)|документа «Назначение услуг»]]. | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |+Параметры | ||
+ | !|Наименование | ||
+ | !|Обязателен? | ||
+ | !|Тип данных | ||
+ | !|Описание | ||
+ | !|Пример | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>КартаГостя</code> | ||
+ | |Да | ||
+ | |<code>Документ.КартаГостя</code> | ||
+ | |Пациент, которому назначают сеансы | ||
+ | |<code>{"ID": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc22a22d2dea3"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Реквизиты</code> | ||
+ | |Да | ||
+ | |<code></code> | ||
+ | |Структура с реквизитами документа | ||
+ | |<code></code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Врач</code> | ||
+ | |Нет | ||
+ | |<code>Справочник.Сотрудники</code> | ||
+ | |Врач пациента | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Сотрудники?ref=8d2260a44c379a5b11e78e0f7fa8dfd3"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Контрагент</code> | ||
+ | |Да | ||
+ | |<code>Справочник.Контрагенты</code> | ||
+ | |Плательщик | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Контрагенты?ref=96d9708bcda2156111ef1845282817fd"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Договор</code> | ||
+ | |Да | ||
+ | |<code>Справочник.ДоговорыКонтрагентов</code> | ||
+ | |Договор контрагента | ||
+ | |<code>{"ID": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=96e4708bcda2156111ef6a02b963d7ba"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Прайс</code> | ||
+ | |Да | ||
+ | |<code>Справочник.Прайсы</code> | ||
+ | |Прайс для получения установки цен услуг | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Прайсы?ref=9a5b60a44c379a5b11eab0672c82229e"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>яъОрганизация</code> | ||
+ | |Да | ||
+ | |<code>Справочник.Организации</code> | ||
+ | |Прайс для получения установки цен услуг | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Организации?ref=9bc8e4800e39484c4b1e680675db5963"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>мсСеансы</code> | ||
+ | |Да | ||
+ | |<code></code> | ||
+ | |Массив сеансов к назначению | ||
+ | |<code></code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Оборудование</code> | ||
+ | |Да | ||
+ | |<code>Справочник.Номенклатура</code> | ||
+ | |Оборудование, на котором выполняется услуга | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Номенклатура?ref=b87a60a44c379a5b11e84226f79ecc90"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Кабинет</code> | ||
+ | |Да | ||
+ | |<code>Справочник.Помещения</code> | ||
+ | |Кабинет, в котором проводится услуга | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6771c76040"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Услуга</code> | ||
+ | |Да | ||
+ | |<code>Справочник.Услуги</code> | ||
+ | |Услуга сеанса | ||
+ | |<code>{"ID": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>ПараметрыНазначения</code> | ||
+ | |Нет | ||
+ | |<code>Справочник.яъЗначенияСвойств</code> | ||
+ | |Параметры назначения услуги | ||
+ | |<code>{"ID": "e1cib/data/Документ.яъЗначенияСвойств?ref=9a58f2e8cf1cc29211ea9e62826f7645"}</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>фПлатная</code> | ||
+ | |Нет | ||
+ | |<code>Булево</code> | ||
+ | |Платный ли сеанс | ||
+ | |<code>Ложь</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>фСрочная</code> | ||
+ | |Нет | ||
+ | |<code>Булево</code> | ||
+ | |Срочность сеанса | ||
+ | |<code>Ложь</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>ДатаСеанса</code> | ||
+ | |Да | ||
+ | |<code>Дата</code> | ||
+ | |Дата сеанса | ||
+ | |<code>2025-02-24T00:00:00</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>ДатаНачала</code> | ||
+ | |Нет | ||
+ | |<code>Дата</code> | ||
+ | |Начало периода назначаемых сеансов, используется без параметра ДатаСеанса, сеансы будут назначены на каждый день в периоде | ||
+ | |<code>2025-02-24T00:00:00</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>ДатаОкончания</code> | ||
+ | |Нет | ||
+ | |<code>Дата</code> | ||
+ | |Конец периода назначаемых сеансов, используется без параметра ДатаСеанса | ||
+ | |<code>2025-02-28T00:00:00</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>ВремяС</code> | ||
+ | |Да | ||
+ | |<code>Дата</code> | ||
+ | |Время начала сеанса | ||
+ | |<code>0001-01-01T08:00:00</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>ВремяДо</code> | ||
+ | |Да | ||
+ | |<code>Дата</code> | ||
+ | |Время окончания сеанса | ||
+ | |<code>0001-01-01T08:40:00</code> | ||
+ | |||
+ | |- | ||
+ | |||
+ | |<code>Комментарий</code> | ||
+ | |Нет | ||
+ | |<code>Строка</code> | ||
+ | |Комментарий к услуге | ||
+ | |<code></code> | ||
+ | |} | ||
+ | |||
+ | ;Пример запроса: | ||
+ | <pre class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;"> | ||
+ | { | ||
+ | "КартаГостя": { | ||
+ | "Идентификатор": "e1cib/data/Документ.КартаГостя?ref=96f6708bcda2156111eff283b864d0aa" | ||
+ | }, | ||
+ | |||
+ | "Реквизиты": { | ||
+ | "Врач": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=8d2260a44c379a5b11e78e0f7fa8dfd3" | ||
+ | }, | ||
+ | "Контрагент": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Контрагенты?ref=96d9708bcda2156111ef1845282817fd" | ||
+ | }, | ||
+ | "Договор": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=96e4708bcda2156111ef6a02b963d7ba" | ||
+ | }, | ||
+ | "Прайс": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Прайсы?ref=9a5b60a44c379a5b11eab0672c82229e" | ||
+ | }, | ||
+ | "яъОрганизация": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Организации?ref=9bc8e4800e39484c4b1e680675db5963" | ||
+ | } | ||
+ | }, | ||
+ | |||
+ | "мсСеансы": [ | ||
+ | { | ||
+ | "Услуга": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70" | ||
+ | }, | ||
+ | "ПараметрыНазначения": { | ||
+ | "Идентификатор": "e1cib/data/Документ.яъЗначенияСвойств?ref=00000000000000000000000000000000" | ||
+ | }, | ||
+ | "Кабинет": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Помещения?ref=bc8dd85ed320709611ecda6cb7b0a370" | ||
+ | }, | ||
+ | "Оборудование": { | ||
+ | "Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=b20b6451060d98bd11e58e90c8070481" | ||
+ | }, | ||
+ | "ДатаСеанса": "2025-02-25T00:00:00", | ||
+ | "ВремяС": "0001-01-01T10:00:00", | ||
+ | "ВремяДо": "0001-01-01T10:30:00", | ||
+ | "КоличествоМест": 1, | ||
+ | "Комментарий": "", | ||
+ | "фПлатная": false, | ||
+ | "фСрочная": false | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | </pre> | ||
+ | |||
+ | ;Пример ответа: | ||
+ | <pre> | ||
+ | { | ||
+ | "Дата": "2025-02-28T11:53:44", | ||
+ | "Номер": "25/00020 ", | ||
+ | "Идентификатор": "e1cib/data/Документ.НазначениеУслуг?ref=96f6708bcda2156111eff5a929db2b8e" | ||
} | } | ||
</pre> | </pre> |
Текущая версия на 18:32, 28 февраля 2025
Методы
Общие
GetNews
Содержимое ленты новостей.
Необязательные параметры:
- Параметры: структура параметров, которые используются в шаблонах страницы.
- Развернуть: если значение «Истина», то новости будут развернуты при загрузке страницы.
- ОграничитьШирину: если значение «Истина», то новости будут отображаться посередине экрана, образуя «Ленту» новостей.
- ВКонтейнер: если значение «Истина», то к макетам будет подключена стандартная библиотека.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetNews&raw&Параметры={"Развернуть":true,"ОграничитьШирину":true}
- Пример ответа
развернуть
ИзменитьСтатусУчастникаМероприятия
Изменение статуса участника на мероприятии. Если участник не числился, то он будет добавлен.
Параметры:
- Участник: участник (карта гостя или физлицо), у которого необходимо изменить статус.
- Мероприятие: мероприятие, на котором необходимо изменить статус участника.
Необязательные параметры:
- Статус: требуемый статус участника (ПотенциальныйУчастник, БудетУчаствовать, ПринялУчастие, Отказ). Если не передан, то будет установлен «Принял участие».
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ИзменитьСтатусУчастникаМероприятия&Участник={"Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=8e086451060d98bd11e5c8f3aff6f11f"}&Мероприятие={"Идентификатор": "1cib/data/Документ.яъМероприятие?ref=9511a85e4511756911ee74bb0ffc8d41"}&Статус=Отказ
- Пример ответа
развернуть
PaymentStatusByDocument
Состояние оплаты по документа.
Параметры:
- Document: документ, по которому нужно получить состояние оплаты.
Необязательные параметры:
- Детализация: в результат будет помещена таблица с расшифровкой состояния оплаты по каждому счету.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=PaymentStatusByDocument&Document={"Идентификатор": "e1cib/data Документ.НазначениеУслуг?ref=bca2d85ed320709611ed8129e69655fb"}
- Пример ответа
развернуть
КонтактыОрганизации
Контактные данные рабочей организации.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=КонтактыОрганизации
- Пример ответа
развернуть
ПользовательПоНаименованию
Данные пользователя по наименованию.
Параметры:
- Наименование: наименование пользователя.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ПользовательПоНаименованию&Наименование=Администратор
- Пример ответа
развернуть
ОфициальныеОрганы
Список официальных органов.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ОфициальныеОрганы
- Пример ответа
развернуть
РабочаяОрганизация
Рабочая организация по настройке.
Параметры:
- стрРеквизиты (не поддерживается): список реквизитов для получения.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=РабочаяОрганизация&стрРеквизиты=Код,Наименование
- Пример ответа
развернуть
GetHtmlForms
Макеты HTML виджетов.
Параметры:
- Категория: ссылка на категорию (владельца) или ее полный идентификатор.
Необязательные параметры:
- Вычислить: если значение «Истина», то макеты будут вычислены на стороне конфигурации.
- ВКонтейнер: если значение «Истина», то к макетам будет подключена стандартная библиотека.
- Параметры: структура с параметрами, которые используются в макетах.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetHtmlForms&Категория=Справочник.яъКатегории.ВиджетНовости&Вычислить=Истина&ВКонтейнер=Ложь
- Пример ответа
развернуть
Модуль «Гостиница»
GetAvailableDates
Доступные интервалы заезда за период.
Параметры:
- ArrivalFrom/ЗаездС: начало периода заезда.
- ArrivalTo/ЗаездПо: конец периода заезда.
- Days/КоличествоДней: желаемое количество дней проживания.
Необязательные параметры:
- RoomCategory/КатегорияНомера: желаемая категория номера.
- Block/Корпус: желаемый корпус.
- QuotaID/Квота: требуемая квота (учитываются только квоты по номерам).
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetAvailableDates&ArrivalFrom=30.08.2023&ArrivalTo=05.09.2023&Days=4&RoomCategory={"Идентификатор":%20"e1cib/data/Справочник.НоменклатураПомещений?ref=ac2360a44c379a5b11e565e573e3b690"}&Block={"Идентификатор":%20"e1cib/data/Справочник.Здания?ref=bd4860a44c379a5b11e3a8f481c4453e"}&QuotaID={"Идентификатор":%20"e1cib/data/Справочник.Квоты?ref=9a6860a44c379a5b11eb9d1bc1a84df1"}
- Пример ответа
развернуть
GetPrice
Стоимость проживания за период по различным параметрам.
Необязательные параметры:
- DateFrom/НачалоПериода/ДатаЗаезда: начало периода проживания. Значение по умолчанию - начало текущего дня.
- DateTo/КонецПериода/ДатаВыезда: конец периода проживания. Значение по умолчанию - конец текущего дня.
- ВариантРасчетаЦен: вариант расчета цены. Значение по умолчанию будет получено из настройки.
- Контекст: структура с различными дополнительными параметрами (Организация, Прайс, Время суток заезда, Время суток выезда, Заезд вечером, Выезд вечером).
- ВидЦен: Идентификатор или ссылка на вид цены. Значение по умолчанию - цена брони.
- Details/Расшифровка: развернуть цену по дням.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetPrice&Контекст={"DateFrom": "15.02.2023", "DateTo":"18.02.2023"}
- Пример ответа
развернуть
КартыГостя
Список карт гостей физического лица.
Параметры:
- ФизЛицо: физическое лицо, по которому необходимо получить карты гостя.
- стрРеквизиты (не поддерживается): список реквизитов для получения.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=КартыГостя&стрРеквизиты="Дата"&ФизЛицо={"Идентификатор":"e1cib/data/Справочник.яъФизическиеЛица?ref=b20b6451060d98bd11e59cb64e7de21e"}
- Пример ответа
развернуть
ДанныеОбОсновнойКартеЛояльности
Данные об основной карте лояльности гостя.
Параметры:
- КартаГостя: карта гостя, по которой необходимо получить карту лояльности.
Необязательные параметры:
- НаДату: дата актуальности бонусов. Если не передана, то будет получено общее количество бонусов на карте.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ДанныеОбОсновнойКартеЛояльности&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}&НаДату=01.04.2023
- Пример ответа
развернуть
GetRoomQuota
Получение данных о квоте номеров за период, обязательно передавать период, за который требуется получить данные: параметры запроса DateFrom и DateTo.
Необязательные параметры
- RoomCategory: если требуется получить данные по определенной категории(ям) номеров, пример &RoomCategory={"ID":"e1cib/data/Справочник.НоменклатураПомещений?ref=88575404a66e4a8911e340740eaeea25"};
- Seats: будет учитываться количество свободных мест при определении доступной квоты, пример вызова: &Seats=true
- TypeOfQuota: вид документа онлайн-квоты, по которым требуется получить квоту. Доступные значения: Travelline, Wubook, KintAPI, пример вызова: &TypeOfQuota=KintAPI
- OrganizationOfStay: если требуется получить квоту, привязанную к определенной организации (актуально для баз в которых ведется учет по нескольким организациям), пример вызова: &OrganizationOfStay={"ID":"e1cib/data/Справочник.Организации?ref=8e8150e54935bd5411e25bc6880bb616"}
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetRoomQuota&DateFrom=2018-08-01T00:00:00&DateTo=2018-08-31T00:00:00
- Пример ответа
развернуть
GetAvailableRooms
Получение данных о доступных (свободных) номерах за период, обязательно передавать период, за который требуется получить данные. Возвращает массив структур с описанием номеров гостиницы. Все доступные поля отображены в разделе "Пример ответа". Обязательные параметры запроса DateFrom - начало периода проживания DateTo - конец периода проживания
Необязательные параметры
- Qty - количество мест в одном номере. Будут подобраны все номера где есть требуемое количество свободных мест. Если не передан - будут подобраны все доступные номера.
- Vacant: если передано значение true - будут подобраны только полностью свободные номера;
- RoomCategory: если требуется получить данные по определенной категории(ям) номеров;
- Room: проверка доступности определенного номера гостиницы;
- OrganizationOfStay: если требуется получить номера, привязанные к определенной организации (актуально для баз в которых ведется учет по нескольким организациям)
- QuotaID: поиск номеров, привязанных к определенной квоте; Например &QuotaID={"ID":"e1cib/data/Справочник.Квоты?ref=813800155d1e281211ec0952ca92c338"}
- ДополнительныеСвойства: вывод дополнительных свойств номера гостиницы;
Время заезда и выезда берется из настроек гостиницы.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetAvailableRooms&DateFrom=2019-09-24T00:00:00&DateTo=2019-09-29T00:00:00&Vacant=true&Qty=2
- Пример ответа
развернуть
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetAvailableRooms&DateFrom=2024-08-23T00:00:00&DateTo=2024-08-29T00:00:00&Vacant=true&КоличествоЭлементов=12&НомерСтраницы=3
GetAvailableCategories
Работает аналогично методу GetAvailableRooms, сворачивает результат по категориям номеров гостиницы.
RoomOccupancy
- Тип HTTP-запроса: GET
- Описание: Получение таблицы с интервалами занятости мест в номерах гостиницы в указанном периоде.
Наименование | Обязателен? | Тип данных | Описание | Пример |
---|---|---|---|---|
ДатаНачала (DateFrom)
|
Да | Дата
|
Дата передается в формате dd.mm.yyyy, либо в формате ISO | 01.01.2024
|
ДатаОкончания (DateTo)
|
Да | Дата
|
Дата передается в формате dd.mm.yyyy, либо в формате ISO | 31.01.2024
|
КатегорияНомера (RoomCategory)
|
Нет | Ссылка на категорию номера
|
Фильтрация результата по полю "Категория номера". | {"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=a33f60a44c379a5b11e586d4889feee7"}
|
PostBooking
Отправка данных для создания новой заявки, в случае успеха метод возвращает номер, дату и идентификатор созданного документа.
Данные для создания заявки передаются в теле запроса в формате json.
Если запрос содержит параметр Test, в качестве результата метода вернется тело POST-запроса и текст в формате JSON, полученный после преобразования данных для создания заявки. Можно использовать для отладки.
Если запрос содержит параметр MakeReservation, будет выполнено предварительное бронирование заявки. Если в периоде пребывания по заявке свободных мест не найдено - заявка создана не будет.
Запрос может содержать массив с данными для одновременной передачи нескольких заявок. В этом случае ответом сервиса является массив с результатом обработки каждой заявки, количество элементов в ответе равно количеству во входящем массиве.
Параметры пребывания могут быть переданы как в шапке, так и в строке массива гостей. Если параметр передан и в строке и в шапке - приоритетным считаем параметр строки. Если передан параметр Room - заявка забронирует места в переданном номере гостиницы.
Данные для создания гостей могут быть переданы двумя способами:
- отдельным элементом строки массива гостей с именем "ФизЛицо", "Гость" или "Guest";
- параметры для создания гостя находятся непосредственно в строке массива гостей.
Ключи структуры JSON можно передавать как кириллицей, так и латиницей. Рекомендуется использовать кириллицу.
Если в контексте создания заявки передан идентификатор заявки (навигационная ссылка или уникальный идентификатор (ID), дата и номер входящего документа (InboundDate, InboundNumber), будет выполнен поиск заявки и обновление реквизитов. Новая заявка создается в том случае, если по идентификатору ничего не найдено.
Структура поля «Guest» может содержать ключ ВидУдостоверения, в этом случае будут заполнены данные об удостоверении личности гостя. В значении этого поля должно быть значение «Паспорт» или произвольное наименование удостоверения, которое есть в базе данных (справочник Справочник «Виды удостоверений»).
Также структура поля «Guest» может содержать ключ Телефон, который необходимо вводить в соответствии с маской страны физлица или контрагента. Телефон используется как ключ уникальности для физлиц (Параметр «ЭтоФизЛицо» = Истина или явно передана категория «Физическое лицо»).
Поля для заполнения данных удостоверения личности: ДокументСерия, ДокументНомер, ДокументДатаВыдачи, ДокументКемВыдан, ДокументКодПодразделения, ДатаРегистрацииПоМестуЖительства.
Передача поля Адрес регистрации: поиск адреса выполняется по ключевому полю ИдентификаторФИАС или FIAS_ID. Если идентификатор не передан, выполняется поиск по наименованию. В запросе это одно из полей: Raw, Наименование, Name.
Так же, может быть передан АдресФактический. Если его нет, но есть АдресРегистрации, то в фактический будет записан адрес регистрации.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/PostData?Method=PostBooking
- Тело запроса (параметры в шапке)
развернуть
- Тело запроса (параметры в строке)
развернуть
- Пример ответа
развернуть
Есть возможность передачи данных для создания медицинской справки для каждого из гостей по заявке. Возможно передать несколько справок.
- Пример заполнения полей справки
развернуть
Дополнительные свойства
Есть возможность установки дополнительных свойств при создании объектов. Для этого в контексте объекта должно быть установлено поле AdditionalProperties. Значение массива - структура описания свойства: поле Property содержит ссылку на свойство (поля ID или GUID) или строковый код свойства, поле Value - его значение.
Пример заполнения поля:
[ { "Property": "Цвет", "Value": "Красный" }, { "Property": { "GUID": "e2634e5a-13e4-22g7-bded-1206a89t4e19" }, "Value": { "GUID": "a56e244a-19e5-11e3-bded-5404a66e4a89" } } ]
Для передачи контактных данных в поле Property можно передать идентификатор вида контактной информации: ЭлектроннаяПочта или Телефон.
развернуть
Пример кода на PHP
Приведённый ниже код демонстрирует, как можно обращаться к этому методу API на языке программирования PHP, который широко используется в разработке веб-сайтов. Он отправляет заявку на бронирование для двух гостей, и указывает одного из них в качестве плательщика (контрагента).
GetBookingInvoice
- Тип HTTP-запроса: GET
- Описание: Метод создает (переформировывает) документ «Счет на оплату» по документу бронирования и возвращает печатную форму «Счета на оплату» в виде двоичных данных.
Наименование | Обязателен? | Тип данных | Описание | Пример |
---|---|---|---|---|
Booking
|
Да | Документ.ЗаявкаПокупателя, Документ.Путевка
|
Ссылка на документ «Заявка покупателя» или «Путевка». | {"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=bca9d85ed320709611ef70efeed77b90"}
|
PrintForm
|
Да | Справочник.яъПечатныеФормы
|
Ссылка на печатную форму документа «Счет на оплату» | {"ID": "e1cib/data/Справочник.яъПечатныеФормы?ref=9b7996e6d857ebf811e3a8f3debae343"}
|
ОтметитьВыполнениеПотребностей
Создание документа «Отметка услуг»
Параметры:
- Пользователь: исполнитель потребностей.
Тело запроса:
- Наряд: контекст заполнения документа.
- Потребности: контекст строк с услугами для отметки выполнения.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ОтметитьВыполнениеПотребностей&Пользователь={"Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=b20b6451060d98bd11e5a7ef357c1a80"}
Тело запроса:
{ "Наряд": { "ДатаНачала": "2023-03-10T00:00:00", "ДатаОкончания": "2023-03-12T00:00:00" }, "Потребности": [ { "Услуга": {"Идентификатор": "e1c://filev/C/Users/na/Documents/InfoBase#e1cib/data/Справочник.Услуги?ref=b33060a44c379a5b11e7af51a0e04cd2"}, "Дата": "2023-03-10T00:00:00", "Кабинет": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c115"}, "ДокументНазначения": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1fdca75068"} } ] }
- Пример ответа
развернуть
PostGuestCard
Создание и регистрация документа «Карта гостя».
Тело запроса (обязательные параметры):
- ФизЛицо: физическое лицо гостя. Можно передать в виде структуры с данными для заполнения или с идентификатором. В структуре с данными также можно передать параметры: «Адрес», «Электронная почта», «Телефон» (может использоваться как ключ уникальности. Необходимо передавать с учетом маски адреса физлица), «Удостоверения» (Массив или структура с данными удостоверений. Значение свойства «ВидДокумента» по умолчанию - Паспорт. Если передан массив, то последнее удостоверение будет установлено в качестве основного удостоверения физлица).
Тело запроса (необязательные параметры):
- ВремяСутокЗаезда: время заезда гостя. Значение по умолчанию берется из настройки «Действующее время суток заезда».
- ВремяСутокВыезда: время выезда гостя. Значение по умолчанию берется из настройки «Действующее время суток Выезда».
- ДатаЗаезда: дата заезда гостя. Значение по умолчанию - текущая дата.
- КоличествоДней: количество дней проживания гостя. Значение по умолчанию берется из настройки «Количество дней по умолчанию».
- ВариантПроживания: вариант проживания гостя. Можно передать в виде строки или структуры с идентификатором. Значение по умолчанию - «Основное место».
- ВариантЛечения: вариант лечения гостя. Можно передать в виде строки или структуры с идентификатором. Значение по умолчанию - «Общий курс процедур».
- ВариантПитания: вариант питания гостя. Можно передать в виде строки или структуры с идентификатором. Значение по умолчанию - «Общий стол».
- НомерГостиницы/Room: номер гостиницы, где будет проживать гость. Если не указан, то вариант проживания будет установлен «Без проживания».
- Прайс/Price: прайс. Значение по умолчанию берется из настройки «Прайс продаж».
- Контрагент/Client: контрагент гостя. Можно передать в виде структуры с данными для заполнения или с идентификатором. В структуре с данными также можно передать параметр «Адрес» (Значение по умолчанию - адрес физического лица), «Электронная почта», «Телефон» (может использоваться как ключ уникальности. Необходимо передавать с учетом маски адреса контрагента). Если контрагент не передан, то он будет создан по физическому лицу.
Дополнительные сведения:
- В качестве договора карты гостя будет выступать основной договор контрагента. Если договора нет, то он будет создан и назначен основным.
- Между физическим лицом и контрагентом всегда будет установлена связь, вне зависимости от того, в каком виде они были переданы.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=PostGuestCard
Тело запроса:
развернуть
- Пример ответа
развернуть
ChangeGuestParameters
Выполнения операций с картой гостя. Изменение параметров пребывания.
Параметры:
- КартаГостя: карта гостя для выполнения операции.
- Операция: название или структура с идентификатором операции.
Доступные операции:
Выбытие
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=Выбытие&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}
- Пример ответа
развернуть
Сокращение пребывания
Тело запроса (необязательные параметры):
- ДатаОперации: дата сокращения пребывания. Значение по умолчанию - текущая дата (или дата заезда, если операция выполняется будущим числом).
- ВремяОперации: время сокращения пребывания. Значение по умолчанию - время выезда гостя.
- СВыбытием: выполнить ли выбытие после сокращения пребывания.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=СокращениеПребывания&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}
Тело запроса:
{ "ДатаОперации": "2023-03-11T00:00:00", "ВремяОперации": "0001-01-01T19:00:00", "СВыбытием": "Истина" }
- Пример ответа
развернуть
Переселение / продление
Тело запроса (необходимо указать один или оба параметра):
- НомерГостиницы: новый номер гостиницы гостя.
- КоличествоДней: количество дней для продления проживания.
Тело запроса (необязательные параметры):
- НовоеВремяВыезда: новое время выезда гостя. Значение по умолчанию - время выезда гостя.
- ДатаОперации: дата переселения гостя.
- ВремяОперации: время переселения гостя.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=ПереселениеПродление&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}
Тело запроса:
{ "КоличествоДней": 4, "ДатаОперации": "2023-03-11T00:00:00", "НовоеВремяВыезда": "0001-01-01T12:00:00", "Причина": "Смерть родственника", "НомерГостиницы": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c12a"} }
- Пример ответа
развернуть
Перерыв пребывания
Тело запроса (необязательные параметры):
- ДатаОперации: дата начала перерыва пребывания. Значение по умолчанию - дата заезда гостя.
- ВремяОперации: время начала перерыва пребывания. Значение по умолчанию - время выезда гостя.
- ДатаОкончанияОперации: дата окончания перерыва пребывания.
- ВремяОкончанияОперации: время окончания перерыва пребывания.
- СохранитьНомер: сохранить номер за гостем. Значение по умолчанию - ложь. Принимает ложь, если указана дата окончания операции.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=ПерерывПребывания&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}
Тело запроса:
{ "ДатаОперации": "2023-03-11T00:00:00", "ВремяОперации": "0001-01-01T12:00:00", "СохранитьНомер": "Истина" }
- Пример ответа
развернуть
Возобновление пребывания
Тело запроса (необязательные параметры):
- ДатаОперации: дата возобновления пребывания. Значение по умолчанию - дата перерыва.
- ВремяОперации: время возобновления пребывания. Значение по умолчанию - время перерыва.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=ВозобновлениеПребывания&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}
Тело запроса:
{ "ДатаОперации": "2023-03-11T00:00:00", "ВремяОперации": "0001-01-01T12:00:00", }
- Пример ответа
развернуть
Изменение пребывания
Тело запроса (обязательные параметры):
- ВидДокумента: название или структура с идентификатором вида документа изменения пребывания.
- ВариантПроживания/ВариантЛечения/ВариантПитания: название или структура с идентификатором параметра пребывания. Для каждого вида документа требуется установить свой параметр. Например, для вида «Заявка на изменение питания» необходимо установить параметр «ВариантПитания».
Тело запроса (необязательные параметры):
- ДатаОперации: дата изменения параметров пребывания.
- ВремяОперации: время изменения параметров пребывания.
- НомерГостиницы: новый номер гостиницы гостя. Требуется только для вида «Заявка на изменение проживания». Параметр обязателен, если до операции вариант проживания гостя был «Без проживания».
- ПомещениеПитания: новое помещение питания гостя. Требуется только для вида «Заявка на изменение питания».
- ОборудованиеПитания: новое оборудование питания гостя. Требуется только для вида «Заявка на изменение питания».
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=ИзменениеПребывания&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}
Тело запроса:
{ "ВидДокумента": "ЗаявкаНаИзменениеПитания", "ВариантПитания": "ОбщийСтол", "ПомещениеПитания": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0f0"}, "ОборудованиеПитания": {"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=b87a60a44c379a5b11e84226f79ecc90"}, "ДатаОперации": "2023-03-18T00:00:00" }
- Пример ответа
развернуть
GetBookingList
Список заявок заявителя.
Так же может возвращать все заявки по периоду, начиная с 21.07.01. Для этого передаётся параметры "НачалоПериода", "КонецПериода". Можно как один, так и оба сразу.
- Пример вызова
/GetData?Method=GetBookingList&Client={"ID":"e1cib/data/Справочник.Контрагенты?ref=aab56c626dc53d6911e8a44b45d09480"}
- Пример ответа
- Аналогично методу GetBookingStatus.
CancelBooking
Запрос на отмену заявки. В теле запроса передается массив идентификаторов заявок и причины отмены. Можно передать общую для всех заявок причину отмены в параметрах запроса, но причина в теле запроса приоритетней причины в параметрах. Метод возвращает массив заявок и результатов отмены.
В зависимости от текущего состояния заявки выполняются следующие действия:
- Принята (документ не проведен): устанавливается пометка на удаление документа, в реквизит "Комментарий" документа записывается причина отмены.
- В работе (документ проведен): создается общий отказ по всем строкам заявки с указанием причины.
- Завершена (создан документ "Путевка"): для каждой путевки, созданной на основании заявки выполняется операция "Снятие брони" с указанием причины.
Если переданная заявка уже отменена, вернется ошибка обработки с соответствующим кодом и описанием.
- Пример вызова
/PostData?Method=CancelBooking&DenyReason={"GUID": "21b146ad-cad2-11e8-9a46-60a44c379a5b"}
- Тело запроса
[ { "Booking": { "GUID": "78fd6678-86d4-11e5-a33f-60a44c379a5b" }, "DenyReason": { "GUID": "49fde0fc-bb04-11e8-b458-5404a66e4a89" } }, { "Booking": { "GUID": "49fde0fc-bb04-11e8-b458-5404a66e4a89" } } ]
- Пример ответа
развернуть
GetBookingStatus
Возвращает статус заявки, в параметрах можно передать массив идентификаторов заявок. Запрос содержит один обязательный параметр Booking.
Дополнительные параметры:
- AdditionalProperties: в результат будут добавлены значения дополнительных свойств заявки, заданных для нее в базе. Список свойств передается через запятую без пробелов. В 1С это поле КОД доп. свойства.
- PrintForm: вывод файла печатной формы в формате PDF. Необходимо передавать ИД печатной формы в базе КУС: PrintForm={"GUID":"c357203b-c09c-11e8-b45b-5404a66e4a89"}
Возможные статусы заявок:
- Принята: Документ не проведен. Её движения не активны.
- Отменена: Документ не проведен и помечен на удаление.
- В работе: Документ проведен и есть не закрытые строки.
- Отказано: Все строки документа закрыты отказам по заявке.
- Завершена: Все строки документа закрыты и есть хотя бы одна созданная по ним путевка.
- Пример вызова
/GetData?Method=GetBookingStatus&Booking=[{"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=b4535404a66e4a8911e89ae406700121"}, {"GUID": "78fd6678-86d4-11e5-a33f-60a44c379a5b"}]
- Пример ответа
развернуть
CheckGuest
Выполняет поиск карты гостя по переданным реквизитам и проверяет ее актуальность.
- Пример структуры параметров
{ "ДатаЗаезда":"2020-07-15T00:00:00", "Физлицо_ДатаРождения":"1949-01-23T00:00:00", "НаДату":"2020-07-28T00:00:00" }
Параметры отбора карты гостя передаются в структуре с имененем "Отбор" или "Filter". Вложенные реквизиты должны быть переданы с разделителем "_", например: дата рождения физлица: "Физлицо_ДатаРождения". Служебные параметры отбора:
- НаДату: на какую дату проверять регистрацию гостя. Если не передан, то проверяется на текущую дату.
- УчитыватьВремя (булево): учитывать время суток заезда и выезда гостя. По умолчанию время не учитывается.
Параметр ВернутьКартуГостя (булево) позволяет вернуть в ответе идентификатор карты гостя, если она найдена и актуальна. По умолчанию возвращается только признак актуальности. Реквизиты карты гостя могут быть получены с помощью предопределенного параметра Fields. Признак успешного поиска карты гостя возвращается в поле КартаГостяНайдена.
- Пример вызова
/GetData?Method=CheckGuest&Отбор={"ДатаЗаезда":"2020-07-15T00:00:00","Физлицо_ДатаРождения":"1949-01-23T00:00:00","НаДату":"2020-07-16T00:00:00"}&ВернутьКартуГостя=true&Fields=ДатаЗаезда,ДатаВыезда
- Пример ответа
{ "Success": true, "Result": { "Date": "2020-07-14T17:13:24", "Number": "t0123/00048", "ID": "e1cib/data/Документ.КартаГостя?ref=977af46d0477991a11ee3cfe22c317ca" "ДатаЗаезда": "2020-07-15T00:00:00", "ДатаВыезда": "2020-07-25T00:00:00", "КартаГостяНайдена": true } }
- Пример ответа с параметром &ВернутьКартуГостя=false
{ "Success": true, "Result": true }
GetGuestData
Возвращает информацию о физлице на основании ссылки на физлицо. Параметры:
- ФизЛицо: структура с ссылкой на физическое лицо, данные о котором необходимо извлечь.
- Пример вызова
/GetGuestData?Физлицо={"Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=bc98d85ed320709611ed0990f9042959"}
- Пример ответа
развернуть
Модуль «Медицина»
НазначенныеИсследования
Назначенные пациенту исследования.
Параметры:
- КартаГостя: карта гостя пациента, по которой нужно получить назначенные исследования.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=НазначенныеИсследования&КартаГостя={"Идентификатор" : "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}
- Пример ответа
развернуть
СвойстваПациента
Список свойств и их значений пациента.
Параметры:
- КартаГостя: карта гостя пациента, по которой нужно получить свойства.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=СвойстваПациента&КартаГостя={"Идентификатор" : "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}
- Пример ответа
развернуть
НазначенияМедикаментов
Список медикаментов по карте гостя.
Параметры:
- КартаГостя: карта гостя, по которой необходимо получить список медикаментов.
- стрРеквизиты (не поддерживается): список необходимых реквизитов. Доступные реквизиты: КартаГостя, Дата, Медикамент, Количество.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=НазначенияМедикаментов&КартаГостя={"Идентификатор" : "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}&стрРеквизиты=""
- Пример ответа
развернуть
ПроцедурныеКабинеты
Помещения категорий «Процедурный кабинет» и «Лаборатория».
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ПроцедурныеКабинеты
- Пример ответа
развернуть
НазначенияИРезультаты
Назначения и результаты пациентов.
Тело запроса (обязательные параметры):
- Параметры: параметры отбора назначений. Можно передать пустую структуру для получения всех назначений. Доступны параметры:
- КартаГостя: карта гостя пациента.
- ФизЛицо: физическое лицо пациента.
- ДокументНазначения: документ назначения.
- фОплата: получить таблицу с оплатой счетов.
- Кабинет: кабинеты, по которым необходимо получить назначения.
- НачалоПериода: начало периода сеансов.
- КонецПериода: конец периода сеансов.
- КатегорияУслуги: получить только услуги переданной категории.
- НаДату: дата документов назначения сеансов.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=НазначенияИРезультаты
Тело запроса:
{ "Параметры": { "КартаГостя": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}, "фОплата": false, "Кабинет": [ {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6735a8e750"} ], "КатегорияУслуги": {"Идентификатор": "e1cib/data/Справочник.яъКатегории?ref=9777f46d0477991a11ede40656633b10"} "НаДату": "2023-03-16T00:00:00", "НачалоПериода": "2023-03-03T00:00:00", "КонецПериода": "2023-03-14T00:00:00" } }
- Пример ответа
развернуть
ПоказателиПациента
Значения показателей пациента по физическому лицу.
Параметры:
- ФизЛицо: физическое лицо, по которому необходимо получить показатели.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ПоказателиПациента&ФизЛицо={"Идентификатор":"e1cib/data/Справочник.яъФизическиеЛица?ref=b20b6451060d98bd11e59cb642414f2b"}
- Пример ответа
развернуть
ОказанныеУслуги
Оказанные услуги исполнителя.
Параметры:
- НачалоПериода: начало периода оказанных услуг.
- КонецПериода: конец периода оказанных услуг.
- Исполнитель: исполнитель услуг.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ОказанныеУслуги&Параметры={"НачалоПериода":"2022-01-14T00:00:00","КонецПериода":"2023-01-18T00:00:00","Исполнитель":{"Идентификатор":"e1cib/data/Справочник.Сотрудники?ref=b20b6451060d98bd11e5a7ef357c1a80"}}
- Пример ответа
развернуть
ИзменитьСостояниеСеанса
Создание документа «Отметка услуг».
Тело запроса (обязательные параметры):
- фОтмена: если истина, то вид документа будет «Неявка на услуги», иначе «Отметка услуг».
- Дата: дата оказания услуги.
- Услуга: услуга для оказания.
- Пациент: физическое лицо или карта гостя пациента.
- Кабинет: кабинет оказания услуги.
- ДокументНазначения: документ назначения услуги, по которому необходимо выполнить отметку.
- КодСтроки: код строки услуги из документа назначения.
Тело запроса (необязательные параметры):
- Исполнитель: исполнитель услуг. Значение по умолчанию - текущий пользователь.
- QRКод: признак отметки услуги по QR-коду.
- фПлатная: признак платности услуги.
- фСрочная: признак срочной услуги.
- ПараметрыНазначения: параметры назначения услуги.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ИзменитьСостояниеСеанса
Тело запроса:
{ "фОтмена": false, "Дата": "2023-03-18T00:00:00", "Услуга": {"Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70"}, "Пациент": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc22a22d2dea3"}, "Исполнитель": {"Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=b20b6451060d98bd11e5a7ef357c1a80"}, "ДокументНазначения": {"Идентификатор": "e1cib/data/Документ.НазначениеУслуг?ref=94fea85e4511756911edc25f873125fc"}, "Кабинет": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6771c76040"}, "КодСтроки": 4, "QRКод": true, "фСрочная": true }
- Пример ответа
развернуть
ДоступноеВремяСеансов
- Тип HTTP-запроса: GET
- Описание: Получение свободных сеансов для назначения
Наименование | Обязателен? | Тип данных | Описание | Пример |
---|---|---|---|---|
Оборудование
|
Нет | Справочник.Номенклатура
|
Отбор по оборудованию. | {"ID": "e1cib/data/Справочник.Номенклатура?ref=b87a60a44c379a5b11e84226f79ecc90"}
|
Кабинет
|
Нет | Справочник.Помещения
|
Отбор по кабинету. | {"ID": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6771c76040"}
|
Услуга
|
Нет | Справочник.Услуги
|
Отбор по услугам. | {"ID": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70"}
|
ПараметрыНазначения
|
Нет | Справочник.яъЗначенияСвойств
|
Отбор по параметрам назначения. | {"ID": "e1cib/data/Документ.яъЗначенияСвойств?ref=9a58f2e8cf1cc29211ea9e62826f7645"}
|
фПлатная
|
Нет | Булево
|
Отбор по платности сеанса | Ложь
|
фСрочная
|
Нет | Булево
|
Отбор по срочности сеанса | Ложь
|
Пол
|
Нет | Строка
|
Отбор по полу сеанса | "Перечисления.яъПол.Мужской", "Перечисления.яъПол.Женский"
|
ПриоритетПодбора
|
Нет | Справочник.Приоритеты
|
Используемый приоритет подбора | {"ID": "e1cib/data/Справочник.Приоритеты?ref=b20b6451060d98bd11e5be9bf893b2c4"}
|
НачалоПериода
|
Нет | Дата
|
Отбор по периоду | "2023-03-18T00:00:00"
|
КонецПериода
|
Нет | Дата
|
Отбор по периоду | "2023-03-19T00:00:00"
|
КартаГостя
|
Нет | Документ.КартаГостя
|
Учитывается занятость пациента. Если у пациента назначен сеанс в период свободного сеанса, то такой сеанс стаёт недоступен. | {"ID": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc22a22d2dea3"}
|
- Пример запроса
развернуть
ОтменитьСеанс
- Тип HTTP-запроса: POST
- Описание: Создание документа «Отмена назначений услуг» и заполнение его реквизитов. Данные заполнения следует брать из результата метода НазначенияИРезультаты.
- Пример запроса
развернуть
- Пример ответа
true
ПеренестиСеанс
- Тип HTTP-запроса: POST
- Описание: Создание документа «Перенос услуг» и заполнение его реквизитов. Данные заполнения следует брать из результата метода НазначенияИРезультаты.
- Пример запроса
развернуть
- Пример ответа
true
НазначитьУслуги
- Тип HTTP-запроса: POST
- Описание: Создание документа «Назначение услуг».
Наименование | Обязателен? | Тип данных | Описание | Пример |
---|---|---|---|---|
КартаГостя
|
Да | Документ.КартаГостя
|
Пациент, которому назначают сеансы | {"ID": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc22a22d2dea3"}
|
Реквизиты
|
Да |
|
Структура с реквизитами документа |
|
Врач
|
Нет | Справочник.Сотрудники
|
Врач пациента | {"ID": "e1cib/data/Справочник.Сотрудники?ref=8d2260a44c379a5b11e78e0f7fa8dfd3"}
|
Контрагент
|
Да | Справочник.Контрагенты
|
Плательщик | {"ID": "e1cib/data/Справочник.Контрагенты?ref=96d9708bcda2156111ef1845282817fd"}
|
Договор
|
Да | Справочник.ДоговорыКонтрагентов
|
Договор контрагента | {"ID": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=96e4708bcda2156111ef6a02b963d7ba"}
|
Прайс
|
Да | Справочник.Прайсы
|
Прайс для получения установки цен услуг | {"ID": "e1cib/data/Справочник.Прайсы?ref=9a5b60a44c379a5b11eab0672c82229e"}
|
яъОрганизация
|
Да | Справочник.Организации
|
Прайс для получения установки цен услуг | {"ID": "e1cib/data/Справочник.Организации?ref=9bc8e4800e39484c4b1e680675db5963"}
|
мсСеансы
|
Да |
|
Массив сеансов к назначению |
|
Оборудование
|
Да | Справочник.Номенклатура
|
Оборудование, на котором выполняется услуга | {"ID": "e1cib/data/Справочник.Номенклатура?ref=b87a60a44c379a5b11e84226f79ecc90"}
|
Кабинет
|
Да | Справочник.Помещения
|
Кабинет, в котором проводится услуга | {"ID": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6771c76040"}
|
Услуга
|
Да | Справочник.Услуги
|
Услуга сеанса | {"ID": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70"}
|
ПараметрыНазначения
|
Нет | Справочник.яъЗначенияСвойств
|
Параметры назначения услуги | {"ID": "e1cib/data/Документ.яъЗначенияСвойств?ref=9a58f2e8cf1cc29211ea9e62826f7645"}
|
фПлатная
|
Нет | Булево
|
Платный ли сеанс | Ложь
|
фСрочная
|
Нет | Булево
|
Срочность сеанса | Ложь
|
ДатаСеанса
|
Да | Дата
|
Дата сеанса | 2025-02-24T00:00:00
|
ДатаНачала
|
Нет | Дата
|
Начало периода назначаемых сеансов, используется без параметра ДатаСеанса, сеансы будут назначены на каждый день в периоде | 2025-02-24T00:00:00
|
ДатаОкончания
|
Нет | Дата
|
Конец периода назначаемых сеансов, используется без параметра ДатаСеанса | 2025-02-28T00:00:00
|
ВремяС
|
Да | Дата
|
Время начала сеанса | 0001-01-01T08:00:00
|
ВремяДо
|
Да | Дата
|
Время окончания сеанса | 0001-01-01T08:40:00
|
Комментарий
|
Нет | Строка
|
Комментарий к услуге |
|
- Пример запроса
развернуть
- Пример ответа
{ "Дата": "2025-02-28T11:53:44", "Номер": "25/00020 ", "Идентификатор": "e1cib/data/Документ.НазначениеУслуг?ref=96f6708bcda2156111eff5a929db2b8e" }
Подсистема «Предприятие»
GetPaymentQRCode
Формирует и возвращает QR-код для оплаты счета. Может вернуть как структуру из разных видов QR-кодов, так и просто ссылку на него.
Параметры:
- ТипКода: тип необходимого QR-кода. Поддерживаются "СБП" и "Обычный".
- СчетНаОплату: структура, описывающая счёт на оплату, или содержащая ссылку на уже существующий.
- Пример вызова
/GetPaymentQRCode?ТипКода=["СБП", "Обычный"]&СчетНаОплату={"Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc434d07efc77"}
- Пример ответа
развернуть
GetAcceptances
Доступен с версии 21.07.01
Возвращает перечень созданных приёмов платежей по контрагенту, договору и/или счету (в зависимости от переданных параметров).
- Пример вызова
/GetData?Method=GetAcceptances&Контрагент={"ID":%20"e1cib/data/Справочник.Контрагенты?ref=9a6c5404a66e4a8911e5bb8e2aa076f5"}&Счет={"Идентификатор":%20"e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc434d07efc5d"}&Реквизиты=СуммаДокументаБезСкидки
- Пример ответа
развернуть
AcceptPayment
Доступен с версии 21.10.01
Параметры запроса:
- Основание: документ «Заявка», по которому необходимо выставить счет.
- Контрагент: контрагент, которому необходимо выставить счет.
- Договор: договор, контрагента, по которому необходимо выставить счет.
- ЗаполнитьПоДокументу: признак заполнения счета по документу. Если параметр не передан или передан в значении «Ложь», то документ будет заполнен по невыставленным услугам.
- мсУслуги: таблица с услугами. Основными параметрами являются: номенклатура, количество, цена, сумма. Возможна передача пустой цены, в таком случае цена будет получена по настройке ценообразования. Если параметр передан, то параметр «ЗаполнитьПоДокументу» игнорируется.
- ПроцентПредоплаты: процент предоплаты, на который выставляется счет. Если параметр передан, то счет будет выставлен на соответствующий процент количества услуг.
- ОтправитьНаEmail: печатная форма, которую необходимо отправить контрагенту на Email, установленный в его контактных данных. Если параметр передан с пустым значением, то будет отправлена стандартная печатная форма счета на оплату.
- СбербанкИдентификатор: идентификатор платежа в сбербанке. Начиная с релиза 24.01 не используется.
- ЭквайрингИДСчета: идентификатор платежа У Оператора Эквайринга. Используется начиная с релиза 24.01.
- Контекст: структура со значением остальных реквизитов счета.
- Пример вызова
/AcceptPayment
- Счет на предоплату 50% стоимости, заполнение по документу
{ "Контрагент": {"ID": "e1cib/data/Справочник.Контрагенты?ref=9510a85e4511756911ee52ea8a5111a5"}, "Договор": {"ID": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=9510a85e4511756911ee52ea8a5111a6"}, "Основание": {"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=9511a85e4511756911ee698a1ac22021"}, "ЗаполнитьПоДокументу": true, "ПроцентПредоплаты": 50, "ОтправитьНаEmail": null, "Контекст": {"СрокОплаты": "2023-10-13T15:10:45"} }
- Пример ответа
развернуть
- Счет на оплату на 10 единиц номенклатуры.
{ "Контрагент": {"ID": "e1cib/data/Справочник.Контрагенты?ref=9510a85e4511756911ee52ea8a5111a5"}, "Договор": {"ID": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=9510a85e4511756911ee52ea8a5111a6"}, "Основание": {"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=9511a85e4511756911ee698a1ac22021"}, "мсУслуги": [ { "Номенклатура": {"ID": "e1cib/data/Справочник.Номенклатура?ref=9a4e60a44c379a5b11e9b3808b34f6b5"}, "Количество": 10 } ] }
- Пример ответа
развернуть
RegisterPayment
Доступен с версии 21.07.01
Создаёт приём платежей. Должен быть строго POST-запросом. В теле должны содержаться данные для добавления в документ. Основными считаются ссылка на счёт-основание, вид документа и сумма. Все остальные должны передаваться внутри объекта "Контекст".
- Пример запроса
{ "Счет": {"Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc42b9401edbb"}, "ВидДокумента": "ПриемПлатежей", "Сумма": 100, "Контекст": { "ЧекПробитВоВнешнейПрограмме": true, "НомерВходящегоДокумента": "000002", "ДатаВходящегоДокумента": "2021-07-13T13:33:59" } }
- Пример ответа
развернуть
GetInvoices
Доступен с версии 21.07.01
Возвращает перечень счетов по контрагенту, договору или основанию (в зависимости от переданных параметров).
- Пример вызова
/GetData?Method=GetInvoices&Контрагент={"ID":%20"e1cib/data/Справочник.Контрагенты?ref=9a6c5404a66e4a8911e5bb8e2aa076f5"}&Договор={"ID":%20"e1cib/data/Справочник.ДоговорыКонтрагентов?ref=bfdd7085c2c0660b11ebd27de6bcea8a"}&Основание={"ID":"e1cib/data/Документ.ЗаявкаПокупателя?ref=97495404a66e4a8111ec2a58b844326f"}&Fields=СуммаДокумента
- Пример ответа
развернуть
RoomCleaningStatus
Состояние уборки помещений.
Необязательные параметры:
- Исполнитель: исполнитель потребностей. Если не указан, то состояние будет получено по текущему пользователю.
- НаДату: дата уборки. Если не указана, то состояние будет получено на текущую дату.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=RoomCleaningStatus&НаДату=06.03.2023&Исполнитель={"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=94fda85e4511756911edb9bb423b532c"}
- Пример ответа
развернуть
ListRooms
Перечень помещений и категорий.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ListRooms
- Пример ответа
развернуть
ПереченьПотребностей
Список потребностей и их исполнителей.
Необязательные параметры:
- НаДату: дата потребности. Если не указана, то список потребностей будет получен на текущую дату.
- Исполнитель: пользователь исполнителя потребности.
- Помещение: помещение исполнения потребности.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ПереченьПотребностей&НаДату=06.03.2023&Исполнитель={"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=94fda85e4511756911edb9bb423b532c"}
- Пример ответа
развернуть
ЗаписатьУдостоверениеФизлица
Создание основного удостоверения физического лица.
Параметры:
- ФизЛицо: владелец удостоверения.
Тело запроса (обязательные параметры):
- ВидДокумента: вид документа удостоверения.
Тело запроса (необязательные параметры):
- ДокументСерия: серия документа.
- ДокументНомер: номер документа.
- ДокументДатаВыдачи: дата выдачи документа.
- ДокументКемВыдан: кем выдан документ.
- ДокументКодПодразделения: код подразделения документа.
- ДатаРегистрацииПоМестуЖительства: дата регистрации по месту жительства.
- ДействителенДо: дата окончания действия документа.
- ТипВизы: код типа визы МВД.
- КратностьВизы: код кратности визы МВД.
- ЦельВъезда: код цели въезда по визе МВД.
- КодПунктаПересечения: код пункта пересечения границы.
- ПунктПересеченияГраницы: пункт пересечения границы.
- ФилиалФСС: номер филиала ФСС.
- НомерСтрахователя: регистрационный номер страхователя.
- ОкончаниеРегистрации: дата окончания регистрации.
- ТипПолисаОМС: тип полиса ОМС.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ЗаписатьУдостоверениеФизлица&ФизЛицо={"Идентификатор":"e1cib/data/Справочник.яъФизическиеЛица?ref=b20b6451060d98bd11e59cb642414f2b"}
- Тело запроса
развернуть
- Пример ответа
развернуть
РасходныеПоПомещению
Список расходных материалов по помещениям.
Необязательные параметры:
- ДокументНазначения: документ назначения, по которому необходимо получить расходные материалы.
- Услуга: услуга(работа), по которой были добавлены расходные материалы.
- ПараметрыНазначения: параметры назначения услуги, по которой были добавлены расходные материалы.
- ОбъектРабот: помещение, по которому необходимо получить расходные материалы.
- фПлатная: отбор только по платным/бесплатным услугам.
- ДатаТребования/ДатаСеанса: дата требования.
- КодСтроки: код строки требования.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=РасходныеПоПомещению&ДатаТребования=06.03.2023&ДокументНазначения={"Идентификатор": "e1cib/data/Документ.НарядНаРаботы?ref=94fda85e4511756911edb9bb423b532b"}
- Пример ответа
развернуть
Модуль «Питание»
PostMenu
Записывает выбор гостя по меню-раскладке на выбранный день.
Тело запроса:
- Описание шахматки-меню для гостя.
- Пример вызова
Тело запроса:
{ "ИдентификаторКонтекста": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "СодержимоеЗаказа": [ { "Потребность": {"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"}, "Количество": 1 } ] }
ЗаказГостяНаДату
Список блюд по рационам из заказа гостя.
Параметры:
- Параметры: Структура, содержащая параметры:
- НаДату: дата заказа.
- КартаГостя: карта гостя, по которой необходимо получить заказ.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ЗаказГостяНаДату&Параметры={"КартаГостя": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}, "НаДату": "2023-03-04T00:00:00"}
- Пример ответа
развернуть
БлюдаДляЗаказа
Доступные для заказа блюда.
Параметры:
- Параметры: Структура, содержащая параметры:
- НаДату: дата заказного меню.
- ВариантПитания: вариант питания, по которому необходимо получить заказное меню.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=БлюдаДляЗаказа&Параметры={"НаДату": "04.03.2023", "ВариантПитания": {"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=9b7996e6d857ebf811e3a8f3d747934e"}}
- Пример ответа
развернуть
тзУФО_Меню
Документ «Меню-раскладка» на дату.
Параметры:
- Параметры: структура, содержащая:
- Дата: дата меню.
- ВариантПитания: вариант питания, для которого было составлено меню.
- Диета: диета, для которой было составлено меню.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=тзУФО_Меню&Параметры={"Дата":"2023-03-17T00:00:00","Диета":"","ВариантПитания":{"Идентификатор":"e1cib/data/Справочник.НаборыУслуг?ref=9b7996e6d857ebf811e3a8f3d747934e"}}
- Пример ответа
развернуть
ЗаказатьБлюда
Создание документа «Задача» в процессе «Заказ питания».
Тело запроса (обязательные параметры):
- Заявитель: карта гостя заказчик блюд.
- НаДату: срок исполнения заказа.
- мсБлюда: массив структур с блюдами для заказа, содержащих:
- Услуга: услуга (рацион).
- Потребность: блюдо для заказа.
- Количество: количество блюда для заказа.
- Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ЗаказатьБлюда
Тело запроса:
{ "Заявитель": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc2fdd62e6acd"}, "НаДату": "2023-03-22T00:00:00", "мсБлюда": [ { "Услуга": {"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d0"}, "Потребность": {"Идентификатор" : "e1cib/data/Справочник.Номенклатура?ref=91b56451060d98bd11e5ec381c250734"}, "Количество": 1 }, { "Услуга": {"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d2"}, "Потребность": {"Идентификатор" : "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37ee03fce4"}, "Количество": 2 } ] }
- Пример ответа
развернуть
Соответствие имен реквизитов
Внутренний | Внешний |
---|---|
Наименование | Name |
Код | Code |
Идентификатор | ID |
Контрагент | Client |
ОписаниеОшибки | Error |
НомерГостиницы | Room |
КатегорияНомера | RoomCategory |
Дата | Date |
Номер | Number |
НачалоПериода | DateFrom |
КонецПериода | DateTo |
Количество | Qty |
ОрганизацияПребывания | Sanatorium |
Состояние | Status |
ПредварительноЗабронировано | Booked |
Подтверждено | Processed |
Отказано | Denied |
ОсталосьОбработать | ToProcess |
ПричинаОтказа | DenyReason |
Заявка | Booking |
Файл | File |
КоличествоДней | Days |
ОрганизацияПребывания | OrganizationOfStay |
Семья | Family |
Гости | Guests |
Пол | Sex |
СтепеньРодства | Relation |
АдресРегистрации | RegAddress |
ДатаРождения | BirthDate |
НомерСНИЛС | SNILS |
Категория | Category |
МестоРождения | Birthplace |
Гражданство | Citizenship |
стрМестоРаботы | PlaceOfWork |
стрДолжность | Position |
ИдентификаторФИАС | FIAS_ID |
Дом | House |
Корпус | Block |
Квартира | Flat |
ПочтовыйИндекс | ZipCode |
стрДопСвойства | AdditionalProperties |
ПечатнаяФорма | PrintForm |
Квота | QuotaID |
Продавец | Agent |
Прайс | Price |
КатегорияПутевки | VoucherCategory |
Справка | MedicalCertificate |
ЛечебноеУчреждение | MedicalInstitution |
ДиагнозНаправившегоУчреждения | MKB10 |
ДатаВходящегоДокумента | InboundDate |
НомерВходящегоДокумента | InboundNumber |
Коды ошибок
Код ошибки (ErrorCode) | Описание |
---|---|
1020 | Ошибка создания документа «Заявка» методом PostBooking |
1021 | Ошибка обработки файлов, приложенных к заявке или справке. |
1025 | Не найдена заявка по ссылке при запросе статуса методом GetBookingStatus. |
1030 | Не найдена заявка по ссылке при отказе методом CancelBooking. |
1031 | Ошибка установки пометки заявки на удаление методом CancelBooking. |
1032 | Ошибка выполнения отказа по заявке методом CancelBooking. |
1033 | Ошибка снятия брони по подтвержденной заявке методом CancelBooking. |