Версия 14:15, 21 ноября 2024

Содержание

1 Общая информация
2 Общие методы
3 Кинт: Управление санаторием
4 Учет. Анализ. Управление
- 4.1 Методы
  - 4.1.1 PostDocument
    - 4.1.1.1 Изменение документов
- 4.2 Коды ошибок

Общая информация

Введение

API программного продукта позволяет делать интеграции с другим ПО. Например, реализовать личный кабинет на сайте. Для этого, разработчики могут обращаться в базу как для операций обычного чтения, так и для записи.

Требования

База, к которой обращаются, должна быть опубликована на веб-сервере.
1. При публикации базы, должна быть выполнена активация HTTP-сервиса KintAPI.
2. Проверить правильность выполнения публикации можно путём обращения к методу GetDBInfo. Пример: https://demo.kint.ru/kus_demo/hs/KintAPI.hs/GetData?Method=GetDBInfo
Разработчик должен иметь хотя бы минимальные представления о том, что такое HTTP-протокол и JSON-сериализация
1. Что такое тело запроса, и чем оно отличается от параметров
2. Unified Request Location и Unified Request Identifier не должны быть пустыми определениями
3. Виды запросов (POST, GET, OPTIONS) и чем они отличаются
4. Базовая авторизация (если публикация выполнена без предопределения аутентификационных данных)

Вызов методов

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

До версии 21.07, единственным способом вызвать какую-либо функцию, была передача названия в предопределенном параметре Method на URI /pub/hs/KintAPI.hs/GetData или /pub/hs/KintAPI.hs/PostData, в зависимости от типа запроса.

Начиная с релиза 21.07, имя вызываемого метода стало частью URI, и вместо GetData / PostData, стало возможным прописывать имя метода (например, /pub/hs/KintAPI.hs/GetDBInfo). Старый способ вызова методов сохранился для поддержания совместимости с уже реализованными интеграциями.

Помните, что для веб-сервера регистр букв важен, и запрос вида /pub/hs/kintapi.hs/getdbinfo гарантированно приведёт к ошибке 404.

Предопределенные параметры запроса

На поведение сериализатора и API можно влиять путём передачи специальных параметров. Имена параметров можно передавать как на русском, так и на английском языке.

Имя параметра на русском	Имя параметра на английском	Описание	Пример значения	Значение по-умолчанию
`Реквизиты`	`Fields`	Задаёт перечень реквизитов, которые должны быть переданы вместе с ссылками на элементы. Поддерживается получение нестандартных реквизитов: ПредставлениеОбъекта, Идентификатор, GUID.	`Ссылка,Контрагент,КонтактноеЛицо,Договор`	Не задано
`ДополнительныеСвойства`	`AdditionalProperties`	Перечень свойств, которые должны быть добавлены в тело ответа. Ключ под свойство добавляется даже в случае отсутствия какого-либо значения.	`Телефон,ЭлектроннаяПочта`	Не задано
`ПреобразоватьКлючи`	`ConvertKeys`	Указывает, необходимо ли переводить ключи с русского на английский (если в встроенном словаре имеется сопоставление).	`true`	Включено
-	`test`	Предназначено более для тестов сериализации. API не будет вызывать метод, и просто вернёт JSON так, как она его получила и "пропарсила" из POST-запроса.	Значение не требуется, достаточно просто передать параметр	Не используется
-	`raw`	Возвращает ответ (если представляется возможным) сырым телом, без какой-либо сериализации. Не должно использоваться в нормальных ситуациях.	Значение не требуется, достаточно просто передать параметр	Не используется

Формат ответа

API возвращает ответы всегда в формате JSON, даже если запрашивается иной через заголовок Accept. В качестве Content-Type задано значение application/json;charset=utf-8.

Структура ответа содержит два поля:

Success - флаг успешности выполнения, присутствует всегда
Result - результат выполнения

В зависимости от Success и вызываемого метода, результат может быть разным. Для случаев, когда вызов завершился ошибкой, структура гарантированно следующая:

Error - описание ошибки
КодОшибки - код ошибки

{
    "Success": false,
    "Result": {
        "Error": "Метод конфигурации «ИмяМетода» не найден!",
        "КодОшибки": 1000
    }
}

Коды ошибок

Есть небольшой набор предопределенных кодов ошибок, которые могут быть вызваны по тем или иным причинам в любом продукте.

Код ошибки (ErrorCode)	Описание
1000	Передано некорректное или не существующее имя метода
1001	Переданы некорректные параметры запроса
1002	Передан некорректный текст POST запроса
1010	Внутренняя ошибка конфигурации, при возникновении ошибки напишите об этом на spp@kint.ru
1032	При отмене заявки оказалось что она уже отменена, необходимо со стороны сайта написать обработчик такой ситуации
1100	Не передан параметр с видом справочника
1101	Переданный вид справочника отсутствует в конфигурации
1102	Элемент справочника не найден по полям поиска
1103	По полям поиска найдено несколько подходящих элементов
1104	Ошибка записи элемента справочника, возможно переданы не все обязательные реквизиты

Запрос

Передача параметров методу зависит от самого метода, но есть некоторые принятые стандарты в их отношении.

Если параметр требует передачу любого ссылочного объекта - передаётся JSON-структура с одним из ключевых полей: ID или GUID.
- ID - навигационная ссылка на объект в базе 1С: Предприятия: e1cib/data/Справочник.НоменклатураПомещений?ref=b4585404a66e4a8911e8bb0449fde0fc
- GUID - уникальный идентификатор ссылки: 49fde0fc-bb04-11e8-b458-5404a66e4a89
- Важное замечание: Поиск по ID работает быстрее поиска по GUID, потому приоритет остаётся за ним при передаче двух полей одновременно.
Для предопределенных значений и элементов перечислений доступен поиск по имени предопределенного элемента, например Перечисление.яъПол.Мужской.
Файлы приложений должны быть закодированы в формат base64 и переданы внутри тела JSON-объекта, в ключе File.

Авторизация

Для подключения к базе-источнику требуется передать имя и пароль пользователя базы данных: пользователь должен быть добавлен в список пользователей информационной базы. Это ограничение, накладываемое платформой 1С: Предприятие. Передача данных передаётся с помощью стандартного механизма HTTP-аутентификации, подробнее о нём прочитать можно здесь.

Если произвести авторизацию не представляется возможным, можно произвести публикацию базы с беcпарольной аутентификацией (когда пользователь и его пароль прописаны на веб-сервере в default.vrd), но имейте в виду, что в таком случае любой, у кого будет ссылка на неё, сможет заходить в базу через режим 1С: Предприятие, если соответствующие права у пользователя имеются.

Пагинация

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

Имя параметра на русском	Имя параметра на английском	Описание	Пример значения	Значение по умолчанию
`КоличествоЭлементов`	`CountOnPage`	Количество элементов в результате запроса.	`100`	`0`
`НомерСтраницы`	`PageNumber`	Номер требуемой части результата запроса.	`10`	`1`

Методы с поддержкой пагинации:

GetCatalog (СписокЭлементов). Пагинация доступна только для объектов, у которых есть свойство «Ссылка».
ПолучитьИзмененияПоУзлу.
GetAvailableRooms.

Пример вызова

/hs/KintAPI.hs/GetData?Method=GetCatalog&CatalogName=яъФизическиеЛица&PageNumber=6&CountOnPage=10

Общие методы

В данном разделе описаны методы, доступные в любой конфигурации. В скобках указано наименование кириллицей, если оно есть.

GetCatalog (СписокЭлементов)

Тип HTTP-запроса: GET
Описание: Возвращает перечень элементов по заданному отбору. Можно использовать для получения списка организаций, категорий номеров и прочего.

Параметры
Наименование	Обязателен?	Тип данных	Описание	Пример
`Вид` / `CatalogName`	Да	`Строка`	Имя объекта, из которого формируется выдача	`Организации`
`Отбор` / `Filter`	Нет	`Структура`	Структура, указывающая, по каким реквизитам и их значениям необходимо делать отбор	`{"ИНН": "1835012280"}`
`Тип` / `CatalogType`	Нет	`Строка`	Вид объекта, по умолчанию "Справочник".	`Справочник`

Пример вызова:

/GetData?Method=GetCatalog&CatalogName=Организации&Fields=Ссылка,ИНН,КПП

Пример вызова для списка документов:

/GetData?Method=GetCatalog&CatalogName=ПоступлениеТоваровУслуг&CatalogType=Документ&Fields=Номер,Дата

Пример вызова с отбором:

/GetData?Method=GetCatalog&CatalogName=Организации&Fields=Ссылка,ИНН,КПП&Filter={"ГоловнаяОрганизация":%20{"ID":"e1cib/data/Справочник.Организации?ref=ad5c5404a66e4a8911e37e83f3ef6892"}}

Пример вызова с пагинацией:

GetData?Method=GetCatalog&CatalogName=яъФизическиеЛица&Fields=Наименование,Пол&PageNumber=24&CountOnPage=100&Filter={"Пол": "Перечисление.яъПол.Мужской"}

Пример ответа

{
    "Success": true,
    "Result":
    [
        {
            "Ссылка":
            {
                "Name": "ОАО санаторий \"Родные просторы\"",
                "ID": "e1cib/data/Справочник.Организации?ref=8e8150e54935bd5411e25bc6880bb616"
            },
            "ИНН": "1835012280",
            "КПП": "184101001"
        },
        {
            "Ссылка":
            {
                "Name": "ООО \"Италмас\"",
                "ID": "e1cib/data/Справочник.Организации?ref=b72f90e6baabdd1411e271b038722897"
            },
            "ИНН": "",
            "КПП": ""
        }
    ]
}

GetDBInfo (ДанныеИБ)

Возвращает информацию о версии информационной базы. Параметров нет. Можно использовать для проверки работоспособности API.

Пример вызова

/GetDBInfo

Проверка работоспособности API

https://<адрес_сервера>/<имя_публикации>/hs/KintAPI.hs/GetDBInfo

Пример ответа

{
    "Success": true,
    "Result": {
        "ВерсияAPI": "1.1",
        "НомерРелиза": "21.11.01"
    }
}

QRCode (КартинкаQR)

Тип HTTP-запроса: GET
Описание: Получает картинку QR-кода по навигационной ссылке переданного объекта в формате BASE64.

ОбъектПоНавигационнойСсылке

Тип HTTP-запроса: GET
Описание:

Параметры
Наименование	Обязателен?	Тип данных	Описание	Пример
`НавигационнаяСсылка`	Да	`Строка`	Навигационная ссылка на объект в информационной базе	`e1cib/data/Справочник.яъФизическиеЛица?ref=9a6c5404a66e4a8911e5bb8e2aa0771f`

GetPrintForm (ПолучитьПечатнуюФорму)

Позволяет получить сформированную печатную форму в выбранном формате.

Параметры:

Объект (GUID, обязательный) - для кого получаем значение параметра
ПечатнаяФорма (GUID, не обязательный только в случае получения значения параметра) - может использоваться для расширения списка параметров. Без печатной формы список параметров может быть ограничен.
Формат (не обязательный только в случае получения значения параметра) - доступны значения: DOCX, HTML5, MXL, PDF, TXT, XLS
ИмяПараметра (Строка, не обязательный) - если передан, то вернется не печатная форма, а значение переданного параметра. По умолчанию доступны параметры на вкладках «Основные» + «Доступные» + «Дополнительные» в форме настройки печатной формы.
стрТипВыходныхДанных (Строка, не обязательный) - может использоваться тип данных Base64 или ДвоичныеДанные, в ином случае возвращает содержимое файла. Значение по умолчанию Base64.

Пример вызова

/GetData?Method=GetPrintForm&Объект={"GUID":%20"dc7970e4-e673-11e9-b48d-5404a66e4a89"}&ПечатнаяФорма={"GUID":%20"09c83fe6-f918-4388-a2ee-b0a3276941d4"}&Формат=PDF

Пример ответа

{
"Success": true,
"Result": "JVBERi0xLjcKJeLjz9MKMSAwIG9iago8PAovRmlsdGVyIC9GbGF0ZURlY29kZQovTGVuZ3RoIDIgMCBSCi9MZW5ndGgxIDU0Nzk2Ci9MZW5ndGgyIDAKL0 ... UlRU9GCg=="
}

Пример вызова для получения значения параметра

/GetData?Method=GetPrintForm&Объект={"GUID":%20"dc7970e4-e673-11e9-b48d-5404a66e4a89"}&ПечатнаяФорма={"GUID":%20"09c83fe6-f918-4388-a2ee-b0a3276941d4"}&ИмяПараметра=ФизЛицо

Пример ответа

{
"Success": true,
"Result": {
"Наименование": "Иванов Иван Иванович",
"Код": "000000793 ",
"Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=813b5404a66e4a8911e35761a7492167",
"ПометкаУдаления": false,
"ЭтоГруппа": false
}
}

GetReport (РезультатУФО)

Позволяет получить результат отчета в переданном формате.

Параметры:

Отчет (GUID, обязательный) - навигационная ссылка на отчет.
ТипФайла - формат результата.
- JSON, CSV позволяют получить таблицу данных отчета
- XLSX, PDF, TXT, DOCX, MXL позволяют получить результат отчета в том же виде, в котором сохраняется табличный документ результата отчета в режиме «1С: Предприятие», данные закодированы в строку BASE64.

Пример вызова

/hs/KintAPI.hs/РезультатУФО?Отчет={"Идентификатор":%20"e1cib/data/Справочник.яъОтчеты?ref=9c415404a66e4a8911e4dcfb89878423"}&Формат=JSON

Пример ответа

{
"Success": true,
"Result": "[
{"Корпус": "Корпус 2","Заехало": 1,"ЗапланированЗаезд": 1},
{"Корпус": "Корпус 33","Заехало": 0,"ЗапланированЗаезд": 0}
]"
}

GetDataSourceInfo (ОписаниеИсточникаДанных)

Позволяет получить описание источника данных в формате JSON.

Параметры:

ИсточникДанных (GUID, обязательный) - навигационная ссылка на источник данных.

Пример вызова

/hs/KintAPI.hs/ОписаниеИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bca1d85ed320709611ed397243b5eb7d

Пример ответа

{
"Success": true,
"Result": "{"Наименование": "Тестовый источник данных","яъКатегория": "Запрос","яъКомментарий": "Используется для примеров и тестирования API","яъАвтор": "Иванов Иван","Измерения": "НомерСтроки,Наименование,Идентификатор,Физлицо,УчетнаяЗапись","Ресурсы": "Количество","Параметры": "","HTTPЗапрос": "http://localhost/base_name/hs/KintAPI.hs/ТаблицаИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bca1d85ed320709611ed397243b5eb7d"n}",
"Messages": []
}

GetDataSource (ТаблицаИсточникаДанных)

Позволяет получить таблицу источника данных в формате JSON.

Параметры:

ИсточникДанных (GUID, обязательный) - навигационная ссылка на источник данных.

Пример вызова

/hs/KintAPI.hs/ТаблицаИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bc79d85ed320709611e346049adc3ab1

Пример вызова с передачей параметров формирования результата

/hs/KintAPI.hs/ТаблицаИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bc79d85ed320709611e346049adc3ab1&НачалоПериода=01.01.2022&КонецПериода=31.01.2022&ИНН=123456788900&Измерения=Контрагент,Договор&Ресурсы=Количество,Сумма

Пример ответа

{
"Success": true,
"Result": "[{"Дело": "Разное","Количество": 7},{"Дело": "КП","Количество": 2},{"Дело": "К:БУ","Количество": 1}]"
}

ЕстьПраваАдминистратора

Тип HTTP-запроса: GET
Описание: Возвращает признак наличия администраторских прав у указанного пользователя.

Параметры
Наименование	Обязателен?	Тип данных	Описание	Пример
`Пользователь`	Да	`СправочникСсылка.яъПользователи`	Ссылка на пользователя, для которого выполняется проверка наличия прав администратора	{ "Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=9b7996e6d857ebf811e3a8f3c11af005" }

Пример вызова

/ЕстьПраваАдминистратора?Пользователь={"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=9b7996e6d857ebf811e3a8f3c11af005"}

Пример ответа

{
    "Success": true,
    "Result": true
}

GetConstant

Тип HTTP-запроса: GET
Описание: Возвращает значение константы, свойства или настройки.

Параметры:

ID/Идентификатор - название требуемой константы или настройки / код требуемого свойства.

Пример вызова

/hs/KintAPI.hs/GetConstant?ID=ПроцентПредоплатыБрони

Пример ответа

{
"Success": true,
"Result": 50,
"Messages": []
}

PostElement

Создание элемента справочника переданного вида. Параметры:

Вид: имя справочника в дереве метаданных или имя предопределенного элемента справочника яъКатегории.

Необязательные параметры:

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

Пример запроса

/hs/KintAPI.hs/PostData?Method=PostElement&Вид=яъРейсы

Тело запроса (создание нового элемента)

{
"Наименование": "Новый рейс",
"ПунктОтправления": {"Идентификатор": "e1cib/data/Справочник.яъПунктыНазначения?ref=98335404a66e4a8111e976225ef1ac20"}
"ПунктПрибытия": {"Идентификатор": "e1cib/data/Справочник.яъПунктыНазначения?ref=98435404a66e4a8111ea6a959c446ea8"}
"Работа":
[
{
"ВидРабот": {"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=977bf46d0477991a11ee8d010588b413"},
"Количество": 10,
"ЕдиницаИзмерения": {"Идентификатор": "e1cib/data/Справочник.КлассификаторЕдиницИзмерения?ref=9b8e002590d756f511e7eb0759c329d2"}
}
]
}

Пример ответа

{
"Success": true,
"Result": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Новый рейс",
"Код": "000000004",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.яъРейсы?ref=977bf46d0477991a11ee929ce65408df"
}

Тело запроса (изменение существующего элемента)

{
"Наименование": "Измененный рейс",
"ПоляПоиска":
{
"Код": "000000004"
}
}

Пример ответа

{
"Success": true,
"Result": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Измененный рейс",
"Код": "000000004",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.яъРейсы?ref=977bf46d0477991a11ee929ce65408df"
}

ПолучитьИзмененияПоУзлу

Получение данных объектов, зарегистрированных в узле плана обмена.

Параметры:

Объекты: структура с параметрами для получения объектов или идентификаторы через «,».
- ИдОбъекта: строка формата <Тип объекта>.<Вид объекта> - идентификатор объекта в конфигурации, перечень элементов которых нужно получить, например: «Справочник.Контрагенты», «Документ.ЗаявкаПокупателя», «ПланСчетов.МедицинскиеПоказатели». Для справочников доступно игнорирование указания типа.
- Отбор: структура с отбором реквизитов для определенного объекта.
- стрРеквизиты: реквизиты через «,» для получения.
Узел: узел плана обмена, по которому необходимо получить зарегистрированные объекты.

Необязательные параметры:

Отбор: структура с общим отбором реквизитов для всех получаемых объектов.
ОтменитьРегистрацию: отменять ли регистрацию объектов в узле после получения. По умолчанию - Истина.
КоличествоЭлементов: количество объектов в результате. Может быть задан для каждого объекта, так и для отдельного.
НомерСтраницы: Номер результата пагинации. Может быть задан для каждого объекта, так и для отдельного.

Пример запроса

/hs/KintAPI.hs/GetData?Method=ПолучитьИзмененияПоУзлу&Объекты=[{"ИдОбъекта":"яъФизическиеЛица","стрРеквизиты":"Наименование,Код"},{"ИдОбъекта":"Контрагенты","Отбор":{"Наименование":"Юридические лица"}}]&Узел={"Идентификатор":"e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}&Отбор={"ЭтоГруппа":true}&ОтменитьРегистрацию=Ложь

Пример ответа

[
{
"Справочник_яъФизическиеЛица": [
{
"Name": "Старше 70",
"Code": "t010003619"
}
]
},
{
"Справочник_Контрагенты": [
{
"Ссылка": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Юридические лица",
"Код": "Т000936  ",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Контрагенты?ref=951ba85e4511756911eec66dccd475d9"
}
}
]
}
]

Пример запроса

/hs/KintAPI.hs/PostData?Method=ПолучитьИзмененияПоУзлуОбъекты=Документ.ЗаявкаГостя,Документ.Путевка&Узел={"Идентификатор":"e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}&Отбор={"Контрагент_ПометкаУдаления":true}

[
{
"Документ_ЗаявкаГостя": [
{
"Ссылка": {
"Дата": "2023-11-27T16:58:25",
"Номер": "23/000000000039",
"Идентификатор": "e1cib/data/Документ.ЗаявкаГостя?ref=bca6d85ed320709611ee8d24a1e9d7c7"
}
}
],
},
{
"Документ_Путевка": [
{
"Ссылка": {
"Дата": "2020-02-26T17:20:59",
"Номер": "З-19/00046     ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=9a58f2e8cf1cc29211ea589ae325f1b1"
}
},
{
"Ссылка": {
"Дата": "2021-09-02T15:33:44",
"Номер": "21/00043       ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=9a6b60a44c379a5b11ec0be19fda8385"
}
},
{
"Ссылка": {
"Дата": "2017-03-20T12:15:07",
"Номер": "demАЛ-0654624  ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=845c60a44c379a5b11e70d4ddd07d0a4"
}
},
{
"Ссылка": {
"Дата": "2017-03-20T12:43:26",
"Номер": "demАЛ-0654625  ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=845c60a44c379a5b11e70d519dffcf81"
}
},
{
"Ссылка": {
"Дата": "2016-11-29T14:52:39",
"Номер": "demАЛ-0654581  ",
"Идентификатор": "e1cib/data/Документ.Путевка?ref=980360a44c379a5b11e6b62b1b6435e6"
}
}
]
}
]

Пример запроса с пагинацией

/hs/KintAPI.hs/GetData?Method=ПолучитьИзмененияПоУзлу&Узел={"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=bc74d85ed320709611ecbf16523724ef"}&Объекты=[{"ИдОбъекта": "Номенклатура", "стрРеквизиты": "Наименование"}, {"ИдОбъекта": "Контрагенты", "стрРеквизиты": "Наименование"}, {"ИдОбъекта": "яъФизическиеЛица", "стрРеквизиты": "Наименование", "КоличествоЭлементов": 20, "НомерСтраницы": 5}]&ОтменитьРегистрацию=Ложь&КоличествоЭлементов=10&НомерСтраницы=4

КоличествоЭлементов

Тип HTTP-запроса: GET
Описание: Получение количества объектов

Параметры
Наименование	Обязателен?	Тип данных	Описание	Пример
`ВидыОбъектов` / `ВидОбъекта`	Да	`Строка`, `Массив`	Тип объекта (По умолчанию справочник), вид объекта	`Организации,Документ.Путевка`
`Отбор` / `Filter`	Нет	`Структура`	Структура, указывающая, по каким реквизитам и их значениям необходимо делать отбор	`{"ИНН": "1835012280"}`
`Узел`	Нет	`Ссылка на узел плана обмена`	В результате окажется количество изменений по узлу	`{"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}`
`КоличествоНаСтранице` / `CountOnPage`	Нет	`Число`	Количество элементов на странице, с указанным параметром будет выводится количество страниц	`100`

Пример вызова 1:

/GetData?Method=КоличествоЭлементов&КоличествоНаСтранице=100&ВидОбъекта=яъФизическиеЛица

Пример ответа:

    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 6733,
            "КоличествоСтраниц": 68
        }
    ]

Пример вызова 2 (Получение количества для нескольких объектов):

/GetData?Method=КоличествоЭлементов&ВидыОбъектов=яъФизическиеЛица,Документ.КартаГостя,РегистрСведений.КурсыВалют

Пример ответа:

    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 6764
        },
        {
            "ВидОбъекта": "Документ.КартаГостя",
            "КоличествоОбъектов": 3000
        },
        {
            "ВидОбъекта": "РегистрСведений.КурсыВалют",
            "КоличествоОбъектов": 3
        }
    ]

Пример вызова 3 (Получение количества с общим отбором):

/GetData?Method=КоличествоЭлементов&ВидыОбъектов=яъФизическиеЛица,Контрагенты,Сотрудники&Отбор={"Код": "000000001"}

Пример ответа:

    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 1
        },
        {
            "ВидОбъекта": "Справочник.Контрагенты",
            "КоличествоОбъектов": 1
        },
        {
            "ВидОбъекта": "Справочник.Сотрудники",
            "КоличествоОбъектов": 0
        }
    ]

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

/GetData?Method=КоличествоЭлементов&ВидыОбъектов=[{ "ВидОбъекта":"яъФизическиеЛица", "Отбор": {"Наименование": "Макадзару"} },{ "ВидОбъекта":"Контрагенты" },{ "ВидОбъекта":"Сотрудники", "Отбор": {"Код": ""} }]&Отбор={"Код": "000000001"}

Пример ответа:

    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 0
        },
        {
            "ВидОбъекта": "Справочник.Контрагенты",
            "КоличествоОбъектов": 1
        },
        {
            "ВидОбъекта": "Справочник.Сотрудники",
            "КоличествоОбъектов": 124
        }
    ]

Пример вызова 5 (Получение количества изменений по общему узлу и получение количества физ. лиц по другому узлу):

/GetData?Method=КоличествоЭлементов&ВидыОбъектов=[{ "ВидОбъекта":"яъФизическиеЛица" },{ "ВидОбъекта":"Контрагенты" },{ "ВидОбъекта":"Сотрудники"},{ "ВидОбъекта": "яъФизическиеЛица", "Узел": {"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=bc74d85ed320709611ecbf16523724ef"} }]&Узел={"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}

Пример ответа:

    [
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 6733
        },
        {
            "ВидОбъекта": "Справочник.Контрагенты",
            "КоличествоОбъектов": 3050
        },
        {
            "ВидОбъекта": "Справочник.Сотрудники",
            "КоличествоОбъектов": 124
        },
        {
            "ВидОбъекта": "Справочник.яъФизическиеЛица",
            "КоличествоОбъектов": 622
        }
    ]

ЗаписатьПриложения

Тип HTTP-запроса: GET/POST
Описание: Запись приложений (например, картинок) к объекту. Можно отправлять как массив, так и структуру. Возвращает список индексов созданных приложений.

Параметры
Наименование	Обязателен?	Тип данных	Описание	Пример
`Владелец`	Да	`Ссылка на объект`	Владелец приложения	`{"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}`
`Индекс`	Нет	`Число`	С указанным параметром перезаписывает старое приложение	`1`
`Файл`	Да	`Строка`	Данные файла в Base64-строке	`"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."`
`Представление`	Да	`Строка`	Имя файла с расширением	`Арбуз.png`
`яъКомментарий`	Нет	`Строка`	Комментарий приложения	`Создан из приложения «Кинт: Мобильный ТСД»`

Пример вызова

/GetData?Method=ЗаписатьПриложения&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Файл="/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."&Представление=Арбуз.png

Пример ответа:

    [
        {
            "Индекс": 11
        }
    ]

УдалитьПриложение

Тип HTTP-запроса: GET
Описание: Удаление приложения

Параметры
Наименование	Обязателен?	Тип данных	Описание	Пример
`Владелец`	Да	`Ссылка на объект`	Владелец приложения	`{"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}`
`Индекс`	Да	`Число`	Номер удаляемого приложения	`11`

Пример вызова

/GetData?Method=УдалитьПриложение&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Индекс=11

Пример ответа:

    true

СписокПриложений

Тип HTTP-запроса: GET
Описание: Получение списка приложений объекта

Параметры
Наименование	Обязателен?	Тип данных	Описание	Пример
`Владелец`	Да	`Ссылка на объект`	Владелец приложений, которые хотим получить	`{"id": "e1cib/data/Справочник.яъФизическиеЛица?ref=96d5708bcda2156111eef01513b24eef"}`
`СФайлами`	Нет	`Булево`	Нужно ли получить файл в Base64-строке	`Истина`
`Колонки`	Нет	`Строка`	Список колонок, который необходимо получить в результате	`Представление,Индекс,яъКомментарий,ИндексТипаПриложения,Файл`

Описание колонок в результате
- Представление - представление приложения
- Индекс - индекс приложения в пределах владельца
- Автор - пользователь, добавивший приложение
- Дата - дата добавления приложения
- фВнешнее - приложение является ссылкой на файл
- ВидПриложения - не используется
- ПутьКДанным - полное имя файла, где хранится приложение
- СостояниеПриложения - 1 (захвачено для редактирования), 0 (никем не редактируется)
- яъКомментарий - комментарий приложения
- ИндексТипаПриложения - 1 (картинка), 2 (каталог), 3 (URL-ссылка), 0 (всё остальное)?
- Файл - файл в Base64-строке
- Расширение - расширение файла

Пример вызова

/GetData?Method=СписокПриложений&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Колонки=Представление,Индекс,Дата,яъКомментарий,Файл&СФайлами=Истина

Пример ответа:

    [
        {
            "Представление": "images.jpeg",
            "Индекс": 1,
            "Дата": "2024-09-17T18:33:57",
            "яъКомментарий": "",
            "Файл": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."
        }
    ]

СоздатьЗадачу (PostTask)

Тип HTTP-запроса: POST
Описание: Создание документа «Задача».

ПолучитьСписокЗадач (GetTaskList)

Тип HTTP-запроса: GET
Описание: Список документов с отбором.

ПолучитьСодержаниеЗадачи (GetTaskContent)

Тип HTTP-запроса: GET
Описание: Получает все комментарии по документу в формате HTML.

ПервыйКомментарий (GetFirstMessage)

Тип HTTP-запроса: GET
Описание: Получает первый комментарий по документу. Первый комментарий считается "Содержанием" документа.

ПоследнийКомментарий (GetLastMessage)

Тип HTTP-запроса: GET
Описание: Получает последний комментарий по документу.

ИзменитьЭтапПроцесса (ChangeProcessStage)

Тип HTTP-запроса: GET
Описание: Изменение этапа процесса документа.

ДобавитьКомментарий (PostMessage)

Тип HTTP-запроса: POST
Описание: Добавление комментария к документу.

Кинт: Управление санаторием

Методы

Общие

GetNews

Содержимое ленты новостей.

Необязательные параметры:

Параметры: структура параметров, которые используются в шаблонах страницы.
- Развернуть: если значение «Истина», то новости будут развернуты при загрузке страницы.
- ОграничитьШирину: если значение «Истина», то новости будут отображаться посередине экрана, образуя «Ленту» новостей.
ВКонтейнер: если значение «Истина», то к макетам будет подключена стандартная библиотека.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetNews&raw&Параметры={"Развернуть":true,"ОграничитьШирину":true}

Пример ответа

<script>
function showMoreInfo(el) {
let elDescription = el.children[1];
elDescription.classList.toggle("event-header-description");

let elInfo = el.parentNode.children[1];
elInfo.classList.toggle("hide");		
}
function expandAllNews() {
document.querySelectorAll('.event-container').forEach(function(event){
showMoreInfo(event);
});	
}
</script>

<style>

.news-container
{
margin: 0 auto;
width: 40%;
}

.event-image
{
border-radius: 10px; 
max-width: 100%;
margin: 15px 0px;
}

.no-events
{
text-align: center;
color: #9b9b9b; 	
}

body
{
background-color: #E0E0E0; 
font-family: verdana;
}

.hide
{
display: none;
}

.event-container
{
background-color: white;
border-radius: 15px;
padding: 10px;
box-shadow: -1px 1px 7px -4px #000000;
cursor: pointer;	
} 

.event-shell
{
background-color: #F5F5F5;
box-shadow: -1px 1px 7px -4px #000000;
border-radius: 15px;
width: 100%;
margin-bottom: 15px;
line-height: 1.5;
color: #3F3F3F;		
}

.event-title
{
font-weight: bold;
font-size: 18px;
} 

.event-container .event-title
{
width: 100%;
word-break: break-all;
}

.event-subtitle
{
font-weight: bold;
font-size: 14px;		
}

.event-header
{
display: flex;
}

.event-time
{
border-radius: 6px;
padding: 3px; 	
font-size: 14px;
text-align: center;	
background-color: #33a7d4;
color: white;
font-weight: bold;
white-space: nowrap;
}

.event-description
{	
font-size: 14px;	
} 

.event-header-description
{ 
height: 3em;
overflow: hidden; 
background: linear-gradient(180deg, #3F3F3F 50%, gray 90%, white 97%);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;	
} 

.event-more-info
{
padding: 10px;
} 

p
{
margin-bottom: 0px;
margin-top: 5px;
} 

.marks-container
{
white-space: nowrap;
color: white;
font-weight: bold;	
} 

</style> 









<script>
document.addEventListener("DOMContentLoaded", function() {
expandAllNews();
});
</script>



<div class = 'news-container'>

<div>    	
<div>	    	
<div class = "event-shell">
<div class = "event-container" onclick = "showMoreInfo(this)">
<div class = "event-header"> 		 
<span class = "event-title">День "Пролетника"</span> 
<span class = "marks-container">
<span class = "event-time">12 сент.</span>
</span>			
</div>

<p class = "event-description event-header-description">
Сегодня птицы массово улетают на юг! Становится прохладнее, дожди начинают идти чаще. <br>
Самое время собирать травы, которые в столь знаменательный день обладают целебными свойствами!
</p>
</div> 

<div class = "event-more-info hide">


<img src = "https://krasivosti.pro/uploads/posts/2021-07/1627080338_22-krasivosti-pro-p-karavan-ptits-ptitsi-krasivo-foto-25.jpg" class = "event-image">


</div>
</div> 

</div>			
</div>

<div>    	
<div>	    	
<div class = "event-shell">
<div class = "event-container" onclick = "showMoreInfo(this)">
<div class = "event-header"> 		 
<span class = "event-title">День рождения компании "Кинт"!</span> 
<span class = "marks-container">
<span class = "event-time">10 окт.</span>
</span>			
</div>

<p class = "event-description event-header-description">
Ежегодное собрание сотрудников предприятия состоится в октябре!
Приносите себя и мягкие стулья! <br>
Непьющих просьба не приходить - презентации смотреть только под коньяк!


</p>
</div> 

<div class = "event-more-info hide">


<img src = "https://algo-s.ru/upload/iblock/345/f02b34eee0160c1cec0a0819b5.png" class = "event-image">



<div class = "event-title"> 
Выступления руководителей отделов
</div>



<div class = "event-description"> 
Сотрудники от каждого отдела расскажут о поставленных и достигнутых целях. 
</div>



<div class = "event-subtitle"> 
Будут ли мягкие стулья?
</div>



<div class = "event-description"> 
А задачу написали?
</div>


</div>
</div> 

</div>			
</div>

</div>

ИзменитьСтатусУчастникаМероприятия

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

Параметры:

Участник: участник (карта гостя или физлицо), у которого необходимо изменить статус.
Мероприятие: мероприятие, на котором необходимо изменить статус участника.

Необязательные параметры:

Статус: требуемый статус участника (ПотенциальныйУчастник, БудетУчаствовать, ПринялУчастие, Отказ). Если не передан, то будет установлен «Принял участие».

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ИзменитьСтатусУчастникаМероприятия&Участник={"Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=8e086451060d98bd11e5c8f3aff6f11f"}&Мероприятие={"Идентификатор": "1cib/data/Документ.яъМероприятие?ref=9511a85e4511756911ee74bb0ffc8d41"}&Статус=Отказ

Пример ответа

{
"Success": true,
"Result": {
"Результат": true,
"Описание": "Статус участия изменен на «Отказ»"
},
"Messages": []
}

PaymentStatusByDocument

Состояние оплаты по документа.

Параметры:

Document: документ, по которому нужно получить состояние оплаты.

Необязательные параметры:

Детализация: в результат будет помещена таблица с расшифровкой состояния оплаты по каждому счету.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=PaymentStatusByDocument&Document={"Идентификатор": "e1cib/data Документ.НазначениеУслуг?ref=bca2d85ed320709611ed8129e69655fb"}

Пример ответа

{
"Success": true,
"Result": {
"СуммаДокумента": 0,
"Выставлено": 1495,
"Оплачено": 1495
},
"Messages": []
}

КонтактыОрганизации

Контактные данные рабочей организации.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=КонтактыОрганизации

Пример ответа

{
[
{
"Владелец": "Санаторий \"Родные просторы\"",
"Свойство": "Портье",
"ТипЗначения": "Контактные данные",
"КодСвойства": "1",
"Период": "2023-03-03T00:00:00",
"_Индекс": 0,
"ЗначениеСвойства": "+7(3412)50-11-99",
"Редактор": "Стеньшина Любовь Александровна (суперюзер)",
"Код": "1"
},
{
"Владелец": "Санаторий \"Родные просторы\"",
"Свойство": "Ресепшен",
"ТипЗначения": "Контактные данные",
"КодСвойства": "23",
"Период": "1980-01-01T00:00:00",
"_Индекс": 0,
"ЗначениеСвойства": "+7(3412)64-68-58",
"Редактор": "Абдулов Юрий Владимирович (директор)",
"Код": "23"
},
{
"Владелец": "Санаторий \"Родные просторы\"",
"Свойство": "Приемная",
"ТипЗначения": "Контактные данные",
"КодСвойства": "тел01",
"Период": "2022-10-25T00:00:00",
"_Индекс": 0,
"ЗначениеСвойства": "+7(3412)69-77-72",
"Редактор": "Абдулов Юрий Владимирович (директор)",
"Код": "тел01"
}
]
}

ПользовательПоНаименованию

Данные пользователя по наименованию.

Параметры:

Наименование: наименование пользователя.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ПользовательПоНаименованию&Наименование=Администратор

Пример ответа

{
"Ссылка": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Администратор",
"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=94fca85e4511756911edad038ee22d63"
},
"ПользовательИБ": "Администратор"
}

ОфициальныеОрганы

Список официальных органов.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ОфициальныеОрганы

Пример ответа

[
{
"Код": "200-006",
"Наименование": "ОТДЕЛЕНИЕ УФМС РОССИИ ПО ЧЕЧЕНСКОЙ РЕСПУБЛИКЕ В СТАРОПРОМЫСЛОВСКОМ Р-НЕ Г. ГРОЗНОГО",
"ДатаОкончания": "0001-01-01T00:00:00",
"Идентификатор": "10000",
"КатегорияВладельца":
{
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОрганВыдачиДокументов",
"Наименование": "Орган выдачи документов",
"Идентификатор": "e1cib/data/Справочник.яъКатегории?ref=9a4e60a44c379a5b11e9c40aadd85b17"
}
},
{
"Код": "240-011",
"Наименование": "ТП УФМС РОССИИ ПО КРАСНОЯРСКОМУ КРАЮ В КАНСКОМ Р-НЕ",
"ДатаОкончания": "0001-01-01T00:00:00",
"Идентификатор": "10017",
"КатегорияВладельца":
{
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОрганВыдачиДокументов",
"Наименование": "Орган выдачи документов",
"Идентификатор": "e1cib/data/Справочник.яъКатегории?ref=9a4e60a44c379a5b11e9c40aadd85b17"
}
}
]

РабочаяОрганизация

Рабочая организация по настройке.

Параметры:

стрРеквизиты (не поддерживается): список реквизитов для получения.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=РабочаяОрганизация&стрРеквизиты=Код,Наименование

Пример ответа

{
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Санаторий \"Родные просторы\"",
"Код": "9999999/2",
"Идентификатор": "e1cib/data/Справочник.Организации?ref=9bc8e4800e39484c4b1e680675db5963"
}

GetHtmlForms

Макеты HTML виджетов.

Параметры:

Категория: ссылка на категорию (владельца) или ее полный идентификатор.

Необязательные параметры:

Вычислить: если значение «Истина», то макеты будут вычислены на стороне конфигурации.
ВКонтейнер: если значение «Истина», то к макетам будет подключена стандартная библиотека.
Параметры: структура с параметрами, которые используются в макетах.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetHtmlForms&Категория=Справочник.яъКатегории.ВиджетНовости&Вычислить=Истина&ВКонтейнер=Ложь

Пример ответа

{
"Success": true,
"Result": [
{
"Ссылка": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Распродажа носков",
"Код": 0,
"Идентификатор": "e1cib/data/Справочник.яъПечатныеФормы?ref=9500a85e4511756911edd2da71e3489a"
},
"Code": "РаспродажаНосков",
"Шаблон": "<table> \n\n\u0009<tr>\n\u0009\u0009<th>Материал</th>\n\u0009\u0009<th>Цена</th>\n\u0009</tr> \n\u0009\n\u0009<tr>\n\u0009\u0009<td>Мохровые</td>\n\u0009\u0009<td>199</td>\n\u0009</tr>\n\u0009\n\u0009<tr>\n\u0009\u0009<td>Бархатные</td>\n\u0009\u0009<td>350</td>\n\u0009</tr>\n\u0009\n\u0009<tr>\n\u0009\u0009<td>Дырявые</td>\n\u0009\u0009<td>999999</td>\n\u0009</tr>\n\n</table>\n"
}
],
"Messages": []
}

Модуль «Гостиница»

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"}

Пример ответа

{
"Success": true,
"Result": [
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "1102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c8"
},
"ДатаЗаезда": "2023-08-30T00:00:00",
"ДатаВыезда": "2023-09-03T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "1102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c8"
},
"ДатаЗаезда": "2023-08-31T00:00:00",
"ДатаВыезда": "2023-09-04T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "1102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c8"
},
"ДатаЗаезда": "2023-09-01T00:00:00",
"ДатаВыезда": "2023-09-05T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "1102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c8"
},
"ДатаЗаезда": "2023-09-02T00:00:00",
"ДатаВыезда": "2023-09-06T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "1102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c8"
},
"ДатаЗаезда": "2023-09-03T00:00:00",
"ДатаВыезда": "2023-09-07T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "1102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c8"
},
"ДатаЗаезда": "2023-09-04T00:00:00",
"ДатаВыезда": "2023-09-08T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "1102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c8"
},
"ДатаЗаезда": "2023-09-05T00:00:00",
"ДатаВыезда": "2023-09-09T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "103",
"Код": "1103",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c9"
},
"ДатаЗаезда": "2023-08-30T00:00:00",
"ДатаВыезда": "2023-09-03T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "103",
"Код": "1103",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c9"
},
"ДатаЗаезда": "2023-08-31T00:00:00",
"ДатаВыезда": "2023-09-04T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "103",
"Код": "1103",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c9"
},
"ДатаЗаезда": "2023-09-01T00:00:00",
"ДатаВыезда": "2023-09-05T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "103",
"Код": "1103",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c9"
},
"ДатаЗаезда": "2023-09-02T00:00:00",
"ДатаВыезда": "2023-09-06T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "103",
"Код": "1103",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c9"
},
"ДатаЗаезда": "2023-09-03T00:00:00",
"ДатаВыезда": "2023-09-07T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "103",
"Код": "1103",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c9"
},
"ДатаЗаезда": "2023-09-04T00:00:00",
"ДатаВыезда": "2023-09-08T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "103",
"Код": "1103",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c9"
},
"ДатаЗаезда": "2023-09-05T00:00:00",
"ДатаВыезда": "2023-09-09T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "101",
"Код": "1101",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c7"
},
"ДатаЗаезда": "2023-08-30T00:00:00",
"ДатаВыезда": "2023-09-03T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "101",
"Код": "1101",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c7"
},
"ДатаЗаезда": "2023-08-31T00:00:00",
"ДатаВыезда": "2023-09-04T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "101",
"Код": "1101",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c7"
},
"ДатаЗаезда": "2023-09-01T00:00:00",
"ДатаВыезда": "2023-09-05T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "101",
"Код": "1101",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c7"
},
"ДатаЗаезда": "2023-09-02T00:00:00",
"ДатаВыезда": "2023-09-06T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "101",
"Код": "1101",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c7"
},
"ДатаЗаезда": "2023-09-03T00:00:00",
"ДатаВыезда": "2023-09-07T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "101",
"Код": "1101",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c7"
},
"ДатаЗаезда": "2023-09-04T00:00:00",
"ДатаВыезда": "2023-09-08T00:00:00",
"Свободно": 2
},
{
"Room": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "101",
"Код": "1101",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0c7"
},
"ДатаЗаезда": "2023-09-05T00:00:00",
"ДатаВыезда": "2023-09-09T00:00:00",
"Свободно": 2
}
],
"Messages": []
}

GetPrice

Стоимость проживания за период по различным параметрам.

Необязательные параметры:

DateFrom/НачалоПериода/ДатаЗаезда: начало периода проживания. Значение по умолчанию - начало текущего дня.
DateTo/КонецПериода/ДатаВыезда: конец периода проживания. Значение по умолчанию - конец текущего дня.
ВариантРасчетаЦен: вариант расчета цены. Значение по умолчанию будет получено из настройки.
Контекст: структура с различными дополнительными параметрами (Организация, Прайс, Время суток заезда, Время суток выезда, Заезд вечером, Выезд вечером).
ВидЦен: Идентификатор или ссылка на вид цены. Значение по умолчанию - цена брони.
Details/Расшифровка: развернуть цену по дням.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetPrice&Контекст={"DateFrom": "15.02.2023", "DateTo":"18.02.2023"}

Пример ответа

{
"Success": true,
"Result": [
{
"НомерСтроки": 0,
"Date": "2023-02-15T00:00:00",
"Стоимость": 13000,
"СтоимостьЛечения": 0,
"СтоимостьПитания": 0,
"СтоимостьПроживания": 13000,
"фРучнаяСтоимость": false,
"Скидка": 0,
"СтоимостьБезСкидки": 13000,
"Price": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОсновнойПрайсПродаж",
"Наименование": "Основной прайс продаж",
"Код": "000000001",
"Идентификатор": "e1cib/data/Справочник.Прайсы?ref=9b7996e6d857ebf811e3a8f3d7479350"
},
"КодСтроки": 0,
"РучнаяСкидка": 0,
"Ответственный": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=00000000000000000000000000000000"
}
},
{
"НомерСтроки": 0,
"Date": "2023-02-16T00:00:00",
"Стоимость": 13000,
"СтоимостьЛечения": 0,
"СтоимостьПитания": 0,
"СтоимостьПроживания": 13000,
"фРучнаяСтоимость": false,
"Скидка": 0,
"СтоимостьБезСкидки": 13000,
"Price": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОсновнойПрайсПродаж",
"Наименование": "Основной прайс продаж",
"Код": "000000001",
"Идентификатор": "e1cib/data/Справочник.Прайсы?ref=9b7996e6d857ebf811e3a8f3d7479350"
},
"КодСтроки": 0,
"РучнаяСкидка": 0,
"Ответственный": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=00000000000000000000000000000000"
}
},
{
"НомерСтроки": 0,
"Date": "2023-02-17T00:00:00",
"Стоимость": 13000,
"СтоимостьЛечения": 0,
"СтоимостьПитания": 0,
"СтоимостьПроживания": 13000,
"фРучнаяСтоимость": false,
"Скидка": 0,
"СтоимостьБезСкидки": 13000,
"Price": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОсновнойПрайсПродаж",
"Наименование": "Основной прайс продаж",
"Код": "000000001",
"Идентификатор": "e1cib/data/Справочник.Прайсы?ref=9b7996e6d857ebf811e3a8f3d7479350"
},
"КодСтроки": 0,
"РучнаяСкидка": 0,
"Ответственный": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=00000000000000000000000000000000"
}
},
{
"НомерСтроки": 0,
"Date": "2023-02-18T00:00:00",
"Стоимость": 6500,
"СтоимостьЛечения": 0,
"СтоимостьПитания": 0,
"СтоимостьПроживания": 6500,
"фРучнаяСтоимость": false,
"Скидка": 0,
"СтоимостьБезСкидки": 6500,
"Price": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОсновнойПрайсПродаж",
"Наименование": "Основной прайс продаж",
"Код": "000000001",
"Идентификатор": "e1cib/data/Справочник.Прайсы?ref=9b7996e6d857ebf811e3a8f3d7479350"
},
"КодСтроки": 0,
"РучнаяСкидка": 0,
"Ответственный": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=00000000000000000000000000000000"
}
}
],
"Messages": []
}

КартыГостя

Список карт гостей физического лица.

Параметры:

ФизЛицо: физическое лицо, по которому необходимо получить карты гостя.
стрРеквизиты (не поддерживается): список реквизитов для получения.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=КартыГостя&стрРеквизиты="Дата"&ФизЛицо={"Идентификатор":"e1cib/data/Справочник.яъФизическиеЛица?ref=b20b6451060d98bd11e59cb64e7de21e"}

Пример ответа

[
{
"Дата": "2023-03-14T10:44:55",
"Номер": "23/00083       ",
"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc233ba474f2a"
},
{
"Дата": "2021-09-20T14:39:07",
"Номер": "21/00058       ",
"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=9a6d60a44c379a5b11ec19fefb04ce3a"
}
]

ДанныеОбОсновнойКартеЛояльности

Данные об основной карте лояльности гостя.

Параметры:

КартаГостя: карта гостя, по которой необходимо получить карту лояльности.

Необязательные параметры:

НаДату: дата актуальности бонусов. Если не передана, то будет получено общее количество бонусов на карте.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ДанныеОбОсновнойКартеЛояльности&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}&НаДату=01.04.2023

Пример ответа

{
"Success": true,
"Result": {
"Ссылка": {
"Дата": "2023-03-06T09:51:55",
"Номер": "22/00000003              ",
"Идентификатор": "e1cib/data/Документ.яъКартаПокупателя?ref=94fda85e4511756911edb9bb423b5329"
},
"ПометкаУдаления": false,
"Number": "22/00000003              ",
"Date": "2023-03-06T09:51:55",
"Проведен": true,
"Client": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Романов Игорь Егорович",
"Код": "dem000026",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ФизическиеЛица",
"Наименование": "Физические лица",
"Код": "000000001",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Контрагенты?ref=9b7996e6d857ebf811e3a8f3debae377"
},
"Идентификатор": "e1cib/data/Справочник.Контрагенты?ref=980360a44c379a5b11e6913a7733af63"
},
"ВидСкидки": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"Идентификатор": "e1cib/data/ПланСчетов.яъЦены?ref=00000000000000000000000000000000"
},
"СрокОкончания": "0001-01-01T00:00:00",
"Номинал": 0,
"БонуснаяПрограмма": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Основная",
"Код": "000000001",
"Идентификатор": "e1cib/data/Справочник.яъБонусныеПрограммы?ref=94fda85e4511756911edb9bb423b5327"
},
"Телефон": "",
"яъАвтор": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Стеньшина Любовь Александровна (суперюзер)",
"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=b20b6451060d98bd11e5a7eb037adb81"
},
"DocumentType": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "_ДисконтнаяКарта",
"Наименование": "Карта лояльности",
"Код": "00081",
"Идентификатор": "e1cib/data/Справочник.яъВидыДокументов?ref=9a4a60a44c379a5b11e935b5799a1a4b"
},
"Comment": "",
"яъОрганизация": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Санаторий \"Родные просторы\"",
"Код": "9999999/2",
"Идентификатор": "e1cib/data/Справочник.Организации?ref=9bc8e4800e39484c4b1e680675db5963"
},
"МоментВремени": "06.03.2023 9:51:55; Карта лояльности № 22/00000003 от 06.03.2023",
"Основная": true,
"Статус": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "Активна",
"Наименование": "Активирована",
"Идентификатор": "e1cib/data/Справочник.яъКатегории?ref=94fca85e4511756911edad18caf195a8"
},
"Актуальна": true,
"БонусовНаКарте": 0,
"ШтрихКод": "iVBORw0KGgoAAAANSUhEUgAAALQAAAC0AQAAAAAVtjufAAABgklEQVR4Ae2V0W0D\r\nMQxDtYH231IbuHxU7tIW/SuTrzjG9fxSQLFJ0XX+HPPhb+NV1aP3nulTzTLKW7Om\r\ntSp/zYzy6tbf6ecyzmtGs/c3vIAfZmnWC7imdqZXlecfTpYj9Lfxww8JvkPWAs5v\r\nP/+fqw5TwmAtyTNZjuTaCbalLzSy3D0x+hw7S/J0mI/IKdXUsp7nFuLaFyXLr5pX\r\nA+a4JMe9tfL0XTfE2Q6hRzqdfSY5ntVabnLytRUKcsyqTVl8a/PwVYzXhof1qVU+\r\nybct2BG+pek6yulon5pKSpz9KsjHBEORSpisoxzjPhbe0eXbGEdynviLH3H5Lcbp\r\niU0mGyzMMRNpvbnNxrLclVg4txWAc59bhOusatMCUs/7OsZrbwSdnC08aX6ce2pp\r\nxXbd936KM2g4Gpr8vu7NFPd1wG6oicMedVPcQuirs5cyjyxHdYpSUCHbl+5J7rRw\r\naytDTp7jLOeSzy7LHdl4SpV9bWa5dedWQ291+H3vhPhf48PfxL8AV0I85xcDVSAA\r\nAAAASUVORK5CYII="
},
"Messages": []
}

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

Пример ответа

{
"Success": true,
"Result": [
{
"RoomCategory": {
"Name": "Люкс 2к",
"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=88575404a66e4a8911e340740eaeea25"
},
"DateFrom": "2018-08-06T00:00:00",
"Qty": 2,
"DateTo": "2018-08-31T23:59:59"
"QuotaID": {
"Date": "2018-10-08T12:14:10",
"Number": "demA00025",
"ID": "e1cib/data/Документ.УстановкаКвоты?ref=9a4660a44c379a5b11e8cad221b146ad",
"GUID": "21b146ad-cad2-11e8-9a46-60a44c379a5b"
}
}
]
}

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

Пример ответа

{
"Success": true,
"Result": [
{
"ДатаЗаезда": "2019-09-24T00:00:00",
"ДатаВыезда": "2019-09-29T23:59:59",
"Room": {
"Наименование": "Номер 201",
"Код": "ТТ00000012",
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=b8f7001bfc34542111df326af0fbf7c5",
"ПометкаУдаления": false,
"ЭтоГруппа": false,
"Родитель": {
"Наименование": "Номера лаптя",
"Код": "666",
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=bb9c5404a66e4a8911e7f79b39f2da3e",
"ПометкаУдаления": false,
"ЭтоГруппа": true
}
},
"Block": {
"Наименование": "Корпус 2",
"Код": "000000005",
"Идентификатор": "e1cib/data/Справочник.Здания?ref=b72f90e6baabdd1411e291efe183744d",
"ПометкаУдаления": false
},
"RoomCategory": {
"Наименование": "Люкс 2к",
"Код": "Lux",
"Идентификатор": "e1cib/data/Справочник.НоменклатураПомещений?ref=88575404a66e4a8911e340740eaeea25",
"ПометкаУдаления": false
},
"МестВНомере": 2,
"Category": {
"Наименование": "Гостиничный номер",
"Код": "",
"Идентификатор": "e1cib/data/Справочник.яъКатегории?ref=81bba100d9d99e6248a9bf544ade9963",
"ПометкаУдаления": false
},
"НачалоПериодаКвоты": null,
"КонецПериодаКвоты": null,
"ТребуетсяУборка": true,
"С": 1,
"Свободно": 1,
"До": 12.5,
"Стоимость": 0,
"ПериодПребывания": "с 24 по 29.09.2019 (5.5 суток)",
"ОтВыезда": 6,
"ДоЗаезда": 15,
"ДатаРаботы": "2018-12-19T00:00:00",
"Работа": {
"Наименование": "Смена белья",
"Код": "ТТ0000010",
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=9cf55404a66e4a8911e4285c09474fc0",
"ПометкаУдаления": false,
"ЭтоГруппа": false
},
"РаботыВНомере": "19.12.2018, Смена белья"
}
]
}

Пример вызова

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

Тело запроса (параметры в шапке)

{
"Client": {
"Name": "Иванов Иван Иванович",
"BirthDate": "1980-11-11T00:00:00",
"Sex": "М",
"RegAddress": {},
"FactAddress": {}
},
"Guests": [
{
"Name": "Иванов Сергей Иванович",
"BirthDate": "1995-01-11T00:00:00",
"Sex": "Мужской",
"Relation": {
"Name": "Сын",
"ID": "e1cib/data/Справочник.яъСтепениРодстваФЛ?ref=95965404a66e4a8911e3c1440ad6102b"
}
}
],
"OrganizationOfStay": {
"ID": "e1cib/data/Справочник.Организации?ref=8e8150e54935bd5411e25bc6880bb616"
},
"DateFrom": "2018-10-01T00:00:00",
"Days": 10,
"RoomCategory": {
"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=88575404a66e4a8911e340740eaeea25"
},
"File": "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAQAAADZc7J/AAAABGdBTUEAALGPC/xh..."
}

Тело запроса (параметры в строке)

{
"Client": {
"Name": "Иванов Иван Иванович",
"Телефон": "+7(999)999-99-99",
"ЭтоФизЛицо": true,	
"BirthDate": "1980-11-11T00:00:00",
"Sex": "М",
"RegAddress": {},
"FactAddress": {}
},
"Guests": [
{
"Guest": {
"Name": "Иванов Сергей Иванович",
"Телефон": "+7(999)999-99-99",
"BirthDate": "1995-01-11T00:00:00",
"Sex": "Мужской"
},
"DateFrom": "2023-10-01T00:00:00",
"Days": "10",
"RoomCategory": {
"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=9a4a60a44c379a5b11e91e3b538636ab"
}
}
],
"OrganizationOfStay": {
"ID": "e1cib/data/Справочник.Организации?ref=9bc8e4800e39484c4b1e680675db5963"
}
}

Пример ответа

{
"Success": true,
"Result": {
"Date": "2018-08-21T11:07:37",
"Number": "ТТ0000000173",
"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=b4535404a66e4a8911e8a510e223144c"
}
}

Есть возможность передачи данных для создания медицинской справки для каждого из гостей по заявке. Возможно передать несколько справок.

Пример заполнения полей справки

"MedicalCertificate": [
    {
        "InboundDate":"2018-02-04T00:00:00",
        "InboundNumber":"RR-123123",
        "MKB10":"W26.6",
        "MedicalInstitution":"СПб ГБУЗ Городская Мариинская больница",
        "File":"DFHHFGFM<JGKFYJBDVBDGdBTUEAALGPC/xh..."
    },
    {
        "InboundDate":"2018-09-01T00:00:00",
        "InboundNumber":"RR-123124",
        "MKB10":"W25.6",
        "MedicalInstitution":"СПб ГБУЗ Городская Мариинская больница",
        "File":"DFHHFGFM<JGKFYJBDVBDGdBTUEAALGPC/xh..."
    }
]

Дополнительные свойства

Есть возможность установки дополнительных свойств при создании объектов. Для этого в контексте объекта должно быть установлено поле AdditionalProperties. Значение массива - структура описания свойства: поле Property содержит ссылку на свойство (поля ID или GUID) или строковый код свойства, поле Value - его значение.

Пример заполнения поля:

[
{
"Property": "Цвет",
"Value": "Красный"
},
{
"Property": {
"GUID": "e2634e5a-13e4-22g7-bded-1206a89t4e19"
},
"Value": {
"GUID": "a56e244a-19e5-11e3-bded-5404a66e4a89"
}
}
]

Для передачи контактных данных в поле Property можно передать идентификатор вида контактной информации: ЭлектроннаяПочта или Телефон.

[
{
"Property": "ЭлектроннаяПочта",
"Value": "example@example.com"
},
{
"Property": "Телефон",
"Value": "1-234-567-890"
}
]

Пример кода на PHP

Приведённый ниже код демонстрирует, как можно обращаться к этому методу API на языке программирования PHP, который широко используется в разработке веб-сайтов. Он отправляет заявку на бронирование для двух гостей, и указывает одного из них в качестве плательщика (контрагента).

<?php 

/**
 * Минимальный пример создания заявок в программе «Кинт: Управление санаторием»
 * с помощью HTTP API.
 * 
 * Пример разрабатывался и тестировался на PHP 5.4, требует расширение cURL и
 * JSON.
 */

$configuration = [];
$configuration['url'] = 'http://127.0.0.1/kus'; // Адрес публикации КУС.
$configuration['username'] = 'API'; // Имя пользователя.
$configuration['password'] = ''; // Пароль (если установлен).
$configuration['timeout'] = 30; // Время, через которое запрос будет сброшен. В секундах.

$configuration['service_name'] = 'KintAPI.hs';
$configuration['full_url'] = sprintf('%s/hs/%s', $configuration['url'], $configuration['service_name']);

// Объекты для API (если они уже есть в удалённой базе) сериализуются в
// примитивном виде - в виде структуры с одним полем: "Идентификатор".
$quota = ['Идентификатор' => 'e1cib/data/Справочник.Квоты?ref=b4b85404a66e4a8911eb906c7437a068'];
// Если достоверно известно, что используемый объект - предопределенный, то
// можно записать просто путь к нему без массива. У квот нет предопределенных
// объектов, но предположим, что такой есть, и он называется "Общий". Тогда
// запись будет выглядеть так:
// $quota = 'Справочник.Квоты.Общий';

// Заполним массив гостей произвольными данными.
$currentTime = time(); // Сохраним текущее время для дальнейших манипуляций
$guests = [
    [
        // Заезд оформляем через неделю в 8 утра
        'ДатаЗаезда' => date('c', $currentTime + (86400 * 7)),
        'ВремяСутокЗаезда' => 'Справочник.ВидыВременныхИнтервалов.ДоЗавтрака',

        // А выезд - через две и вечером
        'ДатаВыезда' => date('c', $currentTime + (86400 * 21)),
        'ВремяСутокВыезда' => 'Справочник.ВидыВременныхИнтервалов.ПослеУжина',

        // Если требуется ручной выбор номера - указываем сам номер
        'НомерГостиницы' => ['Идентификатор' => 'e1cib/data/Справочник.Помещения?ref=b8fd001bfc34542111df38c571c15995'],

        // Стоимость. Заполняется, если требуется.
        // 'Стоимость' => 2800,           // Общая стоимость
        // 'СтоимостьЛечения' => 500,     // Стоимость лечения
        // 'СтоимостьПитания' => 1000,    // Стоимость питания
        // 'СтоимостьПроживания' => 1300, // Стоимость проживания

        // ФизЛицо - отдельная структура с информацией о нашем госте, который заезжает.
        'ФизЛицо' => [
            'ДатаРождения' => '1965-07-31T00:00:00', // Мы родились 31-го июля 1965 года
            'Наименование' => 'Роулинг Джоан Кэтлин',
            'Пол' => 'Ж',

            'ДополнительныеСвойства' => [
                [
                    'Свойство' => 'ЭлектроннаяПочта',
                    'Значение' => 'example@mail.ru'
                ],

                [
                    'Свойство' => 'Телефон',
                    'Значение' => '+79121112233'
                ]
            ],

            // Можно передать паспортные данные или любой иной документ.
            'ВидУдостоверения' => 'Паспорт',
            'ДокументСерия' => '9400',
            'ДокументНомер' => '999999',
            'ДокументДатаВыдачи' => '2000-01-01T00:00:00',
            'ДокументКемВыдан' => 'ОТДЕЛ МИГРАЦИОННОГО УЧЕТА И ОФОРМЛЕНИЯ ВИЗ УФМС РОССИИ ПО Г. МОСКВЕ',
            'ДокументКодПодразделения' => '770-001',

            'ИНН' => '1234567890123',

            'АдресРегистрации' => ['ИдентификаторФИАС' => 'afeea607-0207-467f-8c59-562fc634f924'],
            'АдресФактический' => ['ИдентификаторФИАС' => 'deb1d05a-71ce-40d1-b726-6ba85d70d58f'],
            // 'Гражданство' => ['Код' => 'RUS'],
            // 'яъКомментарий' => 'Описание для вставки в Физлицо',
        ],

        'Справка' => [
            [
                'ДатаВходящегоДокумента' => '2000-01-01T00:00:00',
                'НомерВходящегоДокумента' => '000001',
                'ДиагнозНаправившегоУчреждения' => 'W26.6',
                'ЛечебноеУчреждение' => 'СПб ГБУЗ Городская Мариинская больница',

                // Содержимое файла передаётся в BASE64 формате.
                // base64_encode(file_get_contents('/var/www/.../file.png'))
                'Файл' => ''
            ],

            // Можно передать несколько справок, начиная с релиза 21.07 (21-1822).
            // Для этого просто продублируйте структуру выше столько раз, сколько Вам нужно.
        ],

        // Ещё можно прикладывать дополнительно файл к заявке в контексте строки гостя.
        // Содержимое файла передаётся в BASE64 формате.
        // base64_encode(file_get_contents('/var/www/.../file.png'))
        // 'Файл' => ''
    ],

    [
        'ДатаЗаезда' => date('c', $currentTime + (86400 * 7)),
        'ВремяСутокЗаезда' => 'Справочник.ВидыВременныхИнтервалов.ДоЗавтрака',
        'ДатаВыезда' => date('c', $currentTime + (86400 * 21)),
        'ВремяСутокВыезда' => 'Справочник.ВидыВременныхИнтервалов.ПослеУжина',

        // А этот гость с номером не определился. Зато он определился с категорией.
        'КатегорияНомера' => ['Идентификатор' => 'e1cib/data/Справочник.НоменклатураПомещений?ref=88575404a66e4a8911e340740eaeea25'],

        'ФизЛицо' => [
            'ДатаРождения' => '1928-12-06T00:00:00',
            'Наименование' => 'Рубеус Хагрид',
            'Пол' => 'М'
        ]
    ]
];

// Подготавливаем тело запроса.
$getBody = [
    // Если требуется сразу "Забронировать" заявку.
    'MakeReservation' => ''
];
$postBody = [
    'Гости' => $guests,

    // Считаем, что наш контрагент - это самый первый гость.  Для корректной
    // обработки со стороны КУС, добавим ему атрибут "фЭтоФизЛицо".
    'Контрагент' => array_merge($guests[0]['ФизЛицо'], [
        'ЭтоФизЛицо' => true
    ]),

    'Квота' => $quota,
    'яъКомментарий' => "Это комментарий к заявке.\nВ нём можно использовать переносы строк, если нужно."
];

// Отправляем запрос.
$request = curl_init($configuration['full_url'] . '/PostBooking?' . http_build_query($getBody));
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
curl_setopt($request, CURLOPT_TIMEOUT, $configuration['timeout'] * 1000);
curl_setopt($request, CURLOPT_USERPWD, sprintf('%s:%s', $configuration['username'], $configuration['password']));
curl_setopt($request, CURLOPT_POSTFIELDS, json_encode($postBody));
curl_setopt($request, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json'
]);

$responseBody = @json_decode(curl_exec($request), true);
if (!$responseBody)
{
    echo('Произошла критическая ошибка при разборе ответа сервера' . PHP_EOL);
    exit();
}

$exitCode = 0;
$text = '';
if ($responseBody['Success'])
{
    $text = sprintf('Заявка успешно создана под номером %s', trim($responseBody['Result']['Ссылка']['Номер']));
}
else
{
    $text = sprintf('Заявку создать не удалось, ошибка %d: %s', $responseBody['Result']['КодОшибки'], $responseBody['Result']['Error']);
    $exitCode = $responseBody['Result']['КодОшибки'];
}

echo($text . PHP_EOL);
exit($exitCode);

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"}
}
]
}

Пример ответа

{
"Success": true,
"Result": true,
"Messages": []
}

PostGuestCard

Создание и регистрация документа «Карта гостя».

Тело запроса (обязательные параметры):

ФизЛицо: физическое лицо гостя. Можно передать в виде структуры с данными для заполнения или с идентификатором. В структуре с данными также можно передать параметры: «Адрес», «Электронная почта», «Телефон» (может использоваться как ключ уникальности. Необходимо передавать с учетом маски адреса физлица), «Удостоверения» (Массив или структура с данными удостоверений. Значение свойства «ВидДокумента» по умолчанию - Паспорт. Если передан массив, то последнее удостоверение будет установлено в качестве основного удостоверения физлица).

Тело запроса (необязательные параметры):

ВремяСутокЗаезда: время заезда гостя. Значение по умолчанию берется из настройки «Действующее время суток заезда».
ВремяСутокВыезда: время выезда гостя. Значение по умолчанию берется из настройки «Действующее время суток Выезда».
ДатаЗаезда: дата заезда гостя. Значение по умолчанию - текущая дата.
КоличествоДней: количество дней проживания гостя. Значение по умолчанию берется из настройки «Количество дней по умолчанию».
ВариантПроживания: вариант проживания гостя. Можно передать в виде строки или структуры с идентификатором. Значение по умолчанию - «Основное место».
ВариантЛечения: вариант лечения гостя. Можно передать в виде строки или структуры с идентификатором. Значение по умолчанию - «Общий курс процедур».
ВариантПитания: вариант питания гостя. Можно передать в виде строки или структуры с идентификатором. Значение по умолчанию - «Общий стол».
НомерГостиницы/Room: номер гостиницы, где будет проживать гость. Если не указан, то вариант проживания будет установлен «Без проживания».
Прайс/Price: прайс. Значение по умолчанию берется из настройки «Прайс продаж».
Контрагент/Client: контрагент гостя. Можно передать в виде структуры с данными для заполнения или с идентификатором. В структуре с данными также можно передать параметр «Адрес» (Значение по умолчанию - адрес физического лица), «Электронная почта», «Телефон» (может использоваться как ключ уникальности. Необходимо передавать с учетом маски адреса контрагента). Если контрагент не передан, то он будет создан по физическому лицу.

Дополнительные сведения:

В качестве договора карты гостя будет выступать основной договор контрагента. Если договора нет, то он будет создан и назначен основным.
Между физическим лицом и контрагентом всегда будет установлена связь, вне зависимости от того, в каком виде они были переданы.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=PostGuestCard

Тело запроса:

{
	"ФизЛицо": {
		"Наименование": "Бусина Мария Александровна",
		"Пол": "Перечисление.яъПол.Женский",
		"ДатаРождения": "2007-03-02T00:00:00",
		"Адрес": "Россия, г.Ижевск пр. Никитин 38б",
		"Телефон": "+7(999)999-99-99",
		"ЭлектроннаяПочта": "busina.maria2007@gmail.com",
		"Удостоверения": [
			{
				"ВидДокумента": "Паспорт",
				"ДокументСерия": "9412",
				"ДокументНомер": "980-154",
				"ДокументДатаВыдачи": "2012-03-22T00:00:00"
			},
			{
				"ВидДокумента": "ПолисДМС",
				"ДокументНомер": "5467 8490 9843 3609"
			}
		]
	},
	"Контрагент": {
		"Наименование": "Набережный санаторий",
		"ЭлектроннаяПочта": "mailof.contragent@gmail.com",
		"Телефон": "+7(999)999-99-99"
	},
	"ДатаЗаезда": "2023-09-20T00:00:00",
  "КоличествоДней": 14,
  "КатегорияНомера": "",
  "НомерГостиницы": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0ee"},
  "КатегорияПутёвки": "",
  "ВариантЛечения": {"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=b20b6451060d98bd11e5bb4fe5828252"},
  "ВариантПроживания": "ОсновноеМесто"
  "ВозрастГостя": 16 
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2023-09-04T14:11:01",
"Номер": "2323/000021    ",
"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=950fa85e4511756911ee4b0b0bf3acd2"
},
"Messages": []
}

ChangeGuestParameters

Выполнения операций с картой гостя. Изменение параметров пребывания.

Параметры:

КартаГостя: карта гостя для выполнения операции.
Операция: название или структура с идентификатором операции.

Доступные операции:

Выбытие

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=Выбытие&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}

Пример ответа

{
"Success": true,
"Result": true,
"Messages": []
}

Сокращение пребывания

Тело запроса (необязательные параметры):

ДатаОперации: дата сокращения пребывания. Значение по умолчанию - текущая дата (или дата заезда, если операция выполняется будущим числом).
ВремяОперации: время сокращения пребывания. Значение по умолчанию - время выезда гостя.
СВыбытием: выполнить ли выбытие после сокращения пребывания.

Пример вызова

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",
"СВыбытием": "Истина"
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2023-03-13T16:49:00",
"Номер": "23/000000000168",
"Идентификатор": "e1cib/data/Документ.ЗаявкаГостя?ref=94fea85e4511756911edc19c5d279cbe"
},
"Messages": []
}

Переселение / продление

Тело запроса (необходимо указать один или оба параметра):

НомерГостиницы: новый номер гостиницы гостя.
КоличествоДней: количество дней для продления проживания.

Тело запроса (необязательные параметры):

НовоеВремяВыезда: новое время выезда гостя. Значение по умолчанию - время выезда гостя.
ДатаОперации: дата переселения гостя.
ВремяОперации: время переселения гостя.

Пример вызова

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"}
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2023-03-13T16:59:57",
"Номер": "23/000000000169",
"Идентификатор": "e1cib/data/Документ.ЗаявкаГостя?ref=94fea85e4511756911edc19c5d279cc1"
},
"Messages": []
}

Перерыв пребывания

Тело запроса (необязательные параметры):

ДатаОперации: дата начала перерыва пребывания. Значение по умолчанию - дата заезда гостя.
ВремяОперации: время начала перерыва пребывания. Значение по умолчанию - время выезда гостя.
ДатаОкончанияОперации: дата окончания перерыва пребывания.
ВремяОкончанияОперации: время окончания перерыва пребывания.
СохранитьНомер: сохранить номер за гостем. Значение по умолчанию - ложь. Принимает ложь, если указана дата окончания операции.

Пример вызова

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",
"СохранитьНомер": "Истина"
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2023-03-13T17:17:17",
"Номер": "23/000000000172",
"Идентификатор": "e1cib/data/Документ.ЗаявкаГостя?ref=94fea85e4511756911edc1a0aa787ea8"
},
"Messages": []
}

Возобновление пребывания

Тело запроса (необязательные параметры):

ДатаОперации: дата возобновления пребывания. Значение по умолчанию - дата перерыва.
ВремяОперации: время возобновления пребывания. Значение по умолчанию - время перерыва.

Пример вызова

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",
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2023-03-13T17:23:06",
"Номер": "23/000000000173",
"Идентификатор": "e1cib/data/Документ.ЗаявкаГостя?ref=94fea85e4511756911edc1a0aa787ea9"
},
"Messages": []
}

Изменение пребывания

Тело запроса (обязательные параметры):

ВидДокумента: название или структура с идентификатором вида документа изменения пребывания.
ВариантПроживания/ВариантЛечения/ВариантПитания: название или структура с идентификатором параметра пребывания. Для каждого вида документа требуется установить свой параметр. Например, для вида «Заявка на изменение питания» необходимо установить параметр «ВариантПитания».

Тело запроса (необязательные параметры):

ДатаОперации: дата изменения параметров пребывания.
ВремяОперации: время изменения параметров пребывания.
НомерГостиницы: новый номер гостиницы гостя. Требуется только для вида «Заявка на изменение проживания». Параметр обязателен, если до операции вариант проживания гостя был «Без проживания».
ПомещениеПитания: новое помещение питания гостя. Требуется только для вида «Заявка на изменение питания».
ОборудованиеПитания: новое оборудование питания гостя. Требуется только для вида «Заявка на изменение питания».

Пример вызова

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"
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2023-03-14T09:15:10",
"Номер": "23/000000000175",
"Идентификатор": "e1cib/data/Документ.ЗаявкаГостя?ref=94fea85e4511756911edc226c904325b"
},
"Messages": []
}

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"
}
}
]

Пример ответа

{
"Success": true,
"Result": [
{
"Booking": {
"Date": "2018-08-08T12:21:19",
"Number": "ТТ0000000165",
"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=b4535404a66e4a8911e89ae406700121"
},
"Результат": "Заявка подтверждена, автоматическая отмена невозможна!"
}
]
}

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"}]

Пример ответа

{
"Success": true,
"Result": [
{
"Date": "2018-08-08T12:21:19",
"Number": "ТТ0000000165",
"Sanatorium": {
"Name": "ОАО санаторий \"Родные просторы\"",
"ID": "e1cib/data/Справочник.Организации?ref=8e8150e54935bd5411e25bc6880bb616"
},
"Status": "Завершена",
"Booked": 4,
"Denied": 0,
"ToProcess": 0,
"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=b4535404a66e4a8911e89ae406700121"
},
{
"Date": "2018-08-13T20:15:22",
"Number": "ТТ0000000170",
"Sanatorium": {
"Name": "ОАО санаторий \"Родные просторы\"",
"ID": "e1cib/data/Справочник.Организации?ref=8e8150e54935bd5411e25bc6880bb616"
},
"Status": "В работе",
"Booked": 0,
"Denied": 0,
"ToProcess": 1,
"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=b4535404a66e4a8911e89f1413f618ad"
}
]
}

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"}

Пример ответа

{
	"Success": true,
	"Result": {
		"LastNameRu": "Евгений",
		"FirstNameRu": "Никандрович",
		"MiddleName": "",
		"Gender": "Перечисление.яъПол.Мужской",
		"Возраст": 47,
		"ВозрастнаяГруппа": {
			"Наименование": "Взрослые (с 15 лет и старше)",
			"ПометкаУдаления": false,
			"Предопределенный": false,
			"ИмяПредопределенныхДанных": "",
			"Идентификатор": "e1cib/data/Справочник.яъКатегории?ref=bd4860a44c379a5b11e3ab40edb150de"
		},
		"Birthday": "1974-08-10T00:00:00",
		"ИНН": "",
		"BirthplaceRu": {
			"Наименование": null,
			"ПометкаУдаления": null,
			"Предопределенный": null,
			"ИмяПредопределенныхДанных": null,
			"Код": null,
			"Идентификатор": "e1cib/data/Справочник.яъАдреса?ref=00000000000000000000000000000000"
		},
		"Category": {
			"Наименование": null,
			"ПометкаУдаления": null,
			"Предопределенный": null,
			"ИмяПредопределенныхДанных": null,
			"Код": null,
			"Идентификатор": "e1cib/data/Справочник.яъКатегорииФизлиц?ref=00000000000000000000000000000000"
		},
		"КатегорияФизлица": {
			"Наименование": null,
			"ПометкаУдаления": null,
			"Предопределенный": null,
			"ИмяПредопределенныхДанных": null,
			"Код": null,
			"Идентификатор": "e1cib/data/Справочник.яъКатегорииФизлиц?ref=00000000000000000000000000000000"
		},
		"ВидДокумента": {
			"Наименование": "Паспорт гражданина Российской Федерации",
			"ПометкаУдаления": false,
			"Предопределенный": true,
			"ИмяПредопределенныхДанных": "Паспорт",
			"Код": 21,
			"Идентификатор": "e1cib/data/Справочник.ДокументыУдостоверяющиеЛичность?ref=846e60a44c379a5b11e55885c749b7e0"
		},
		"ДокументСерия": "1487",
		"ДокументНомер": "32157",
		"DateOfIssue": "0001-01-01T00:00:00",
		"IssuedBy": "ТЕРРИТОРИАЛЬНЫЙ ПУНКТ УФМС РОССИИ ПО Г. МОСКВЕ В С. КРАСНОЕ",
		"DepartmentCode": "770-147",
		"ДатаРегистрацииПоМестуЖительства": "0001-01-01T00:00:00",
		"ОкончаниеРегистрации": "0001-01-01T00:00:00",
		"ДействителенДо": "0001-01-01T00:00:00",
		"ЭлектроннаяПочта": null,
		"FactAddress": {
			"Наименование": "Российская Федерация, Вологодская обл, г Вологда, Ленина ул, дом № 12, кв. 232",
			"ПометкаУдаления": false,
			"Предопределенный": false,
			"ИмяПредопределенныхДанных": "",
			"Код": "dem0000261",
			"Идентификатор": "e1cib/data/Справочник.яъАдреса?ref=bc98d85ed320709611ed09925386b91b"
		},
		"Телефон": null,
		"RegAddress": {
			"Наименование": "Российская Федерация, Вологодская обл, г Вологда, Ленина ул, дом № 12, кв. 232",
			"ПометкаУдаления": false,
			"Предопределенный": false,
			"ИмяПредопределенныхДанных": "",
			"Код": "dem0000261",
			"Идентификатор": "e1cib/data/Справочник.яъАдреса?ref=bc98d85ed320709611ed09925386b91b"
		}
	}
}

Модуль «Медицина»

НазначенныеИсследования

Назначенные пациенту исследования.

Параметры:

КартаГостя: карта гостя пациента, по которой нужно получить назначенные исследования.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=НазначенныеИсследования&КартаГостя={"Идентификатор" : "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}

Пример ответа

[
{
"Результат": null,
"ДатаСеанса": "2023-03-03T00:00:00",
"Услуга": "Исследование времени кровотечения",
"КатегорияУслуги": "Исследование",
"Кабинет": "210 - Лаборатория",
"ДокументНазначения": "Назначение услуг № demA00698 от 03.03.2023",
"Врач": "Новикова Анна Степановна",
"Персонал": "",
"КартаГостя": "Романов Игорь Егорович (№ 23/00011 от 03.03.2023)",
"ДатаЗаезда": "2023-03-03T00:00:00",
"ДатаВыезда": "2023-03-16T00:00:00",
"Пациент": "Романов Игорь Егорович",
"Комментарий": "",
"ПараметрыНазначения": "",
"Платная": false,
"ЦенаПроцедуры": 45,
"Срочная": false,
"ВремяС": "0001-01-01T08:10:00",
"КодСтроки": 1,
"ВремяДо": "0001-01-01T08:30:00",
"ФизлицоВремяС": "0001-01-01T08:10:00",
"ФизлицоВремяДо": "0001-01-01T08:25:00",
"Оборудование": "Лаборатория",
"Пройдено": 0,
"Неявка": 0,
"Выполнено": false,
"Осталось": 1,
"ПроцентОплаты": 0,
"БлижайшийСеанс": "2023-03-03T00:00:00",
"БлижайшееВремя": "0001-01-01T08:10:00",
"стрРезультат": ""
}
]

СвойстваПациента

Список свойств и их значений пациента.

Параметры:

КартаГостя: карта гостя пациента, по которой нужно получить свойства.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=СвойстваПациента&КартаГостя={"Идентификатор" : "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}

Пример ответа

{
"ЛечащийВрач": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Новикова Анна Степановна",
"Код": "t010000029",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Врачи-терапевты",
"Код": "t010000038",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=b20b6451060d98bd11e5a941c4baa271"
},
"Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=b20b6451060d98bd11e5a7ef5bec932e"
},
"МедицинскаяСправка": {
"Дата": "0001-01-01T00:00:00",
"Номер": "",
"Идентификатор": "e1cib/data/Документ.Справка?ref=00000000000000000000000000000000"
},
"Отделение": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"Идентификатор": "e1cib/data/Справочник.ПодразделенияОрганизаций?ref=00000000000000000000000000000000"
},
"КомментарийПациента": "",
"ДиагнозМКБ10": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"ЭтоГруппа": null,
"Идентификатор": "e1cib/data/Справочник.МКБ10?ref=00000000000000000000000000000000"
},
"ЛечебноеУчреждение": null,
"ДатаЛистаНетрудоспособности": null,
"НомерЛистаНетрудоспособности": null,
"НомерПолиса": null,
"НомерСтрахователя": null,
"СтраховаяКомпания": null,
"ФилиалФСС": null,
"ФизЛицо": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Романов Игорь Егорович",
"Код": "dem0000014",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=980360a44c379a5b11e6913943daceb3"
},
"НомерГостиницы": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "118",
"Код": "0000002118",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c101"
},
"ДатаЗаезда": "2023-03-03T00:00:00",
"ВремяЗаезда": "0001-01-01T12:00:00",
"ДатаВыезда": "2023-03-16T00:00:00",
"ВремяВыезда": "0001-01-01T08:00:00",
"ВариантПроживания": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОсновноеМесто",
"Наименование": "Основное место",
"Код": "00000000003",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ВариантыПроживания",
"Наименование": "Варианты проживания",
"Код": "00000010006",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=9b7996e6d857ebf811e3a8f3d7479344"
},
"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=9b7996e6d857ebf811e3a8f3d7479348"
},
"ВариантЛечения": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОбщийКурсПроцедур",
"Наименование": "С лечением",
"Код": "00002",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "УслугиЛечения",
"Наименование": "Наборы услуг лечения",
"Код": "00001",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=9b7996e6d857ebf811e3a8f3d747934a"
},
"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=9b7996e6d857ebf811e3a8f3d747934b"
},
"ВариантПитания": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОбщийСтол",
"Наименование": "Шведский стол",
"Код": "00002",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "УслугиПитания",
"Наименование": "Наборы услуг питания",
"Код": "00002",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=9b7996e6d857ebf811e3a8f3d747934f"
},
"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=9b7996e6d857ebf811e3a8f3d747934e"
},
"Пол": "Перечисление.яъПол.Мужской",
"Диета": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "ОсновнойВариантСтандартнойДиеты",
"Наименование": "ОВД - основной вариант стандартной диеты",
"Код": "ОВД      ",
"Идентификатор": "e1cib/data/Справочник.дтДиеты?ref=9b7996e6d857ebf811e3a8f3debae350"
},
"МестоПроживания": "118"
}

НазначенияМедикаментов

Список медикаментов по карте гостя.

Параметры:

КартаГостя: карта гостя, по которой необходимо получить список медикаментов.
стрРеквизиты (не поддерживается): список необходимых реквизитов. Доступные реквизиты: КартаГостя, Дата, Медикамент, Количество.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=НазначенияМедикаментов&КартаГостя={"Идентификатор" : "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}&стрРеквизиты=""

Пример ответа

[
    {
        "Количество": 10,
        "Дата": "2023-03-09T00:00:00",
        "КартаГостя": {
            "Дата": "2023-03-03T09:15:21",
            "Номер": "23/00011       ",
            "Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"
        },
        "Медикамент": {
            "ПометкаУдаления": false,
            "Предопределенный": false,
            "ИмяПредопределенныхДанных": "",
            "Наименование": "Аспирин",
            "Код": "dem00000008",
            "ЭтоГруппа": false,
            "Родитель": {
                "ПометкаУдаления": false,
                "Предопределенный": true,
                "ИмяПредопределенныхДанных": "Медикаменты",
                "Наименование": "Медикаменты (лекарственные препараты)",
                "Код": "00000010005",
                "ЭтоГруппа": true,
                "Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=9b7996e6d857ebf811e3a8f3d7479342"
            },
            "Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=ad1660a44c379a5b11e6ec5de753c7c0"
        }
    },
    {
        "Количество": 10,
        "Дата": "2023-03-13T00:00:00",
        "КартаГостя": {
            "Дата": "2023-03-03T09:15:21",
            "Номер": "23/00011       ",
            "Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"
        },
        "Медикамент": {
            "ПометкаУдаления": false,
            "Предопределенный": false,
            "ИмяПредопределенныхДанных": "",
            "Наименование": "Аспирин",
            "Код": "dem00000008",
            "ЭтоГруппа": false,
            "Родитель": {
                "ПометкаУдаления": false,
                "Предопределенный": true,
                "ИмяПредопределенныхДанных": "Медикаменты",
                "Наименование": "Медикаменты (лекарственные препараты)",
                "Код": "00000010005",
                "ЭтоГруппа": true,
                "Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=9b7996e6d857ebf811e3a8f3d7479342"
            },
            "Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=ad1660a44c379a5b11e6ec5de753c7c0"
        }
    }
]

ПроцедурныеКабинеты

Помещения категорий «Процедурный кабинет» и «Лаборатория».

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ПроцедурныеКабинеты

Пример ответа

[
    {
        "Кабинет": {
            "ПометкаУдаления": false,
            "Предопределенный": false,
            "ИмяПредопределенныхДанных": "",
            "Наименование": "Кабинет (Вибромассаж стоп)",
            "Код": "Тер0000011",
            "ЭтоГруппа": false,
            "Идентификатор": "e1cib/data/Справочник.Помещения?ref=9a4e60a44c379a5b11e9bf533d8c9c71"
        }
    },
    {
        "Кабинет": {
            "ПометкаУдаления": false,
            "Предопределенный": false,
            "ИмяПредопределенныхДанных": "",
            "Наименование": "Кабинет (Гидроаэроионизация)",
            "Код": "Тер0000013",
            "ЭтоГруппа": false,
            "Идентификатор": "e1cib/data/Справочник.Помещения?ref=9a4e60a44c379a5b11e9bf533d8c9c7c"
        }
    },
    {
        "Кабинет": {
            "ПометкаУдаления": false,
            "Предопределенный": false,
            "ИмяПредопределенныхДанных": "",
            "Наименование": "Кабинет (Гидромассаж)",
            "Код": "Тер0000014",
            "ЭтоГруппа": false,
            "Идентификатор": "e1cib/data/Справочник.Помещения?ref=9a4e60a44c379a5b11e9bf533d8c9c81"
        }
    }
]

НазначенияИРезультаты

Назначения и результаты пациентов.

Тело запроса (обязательные параметры):

Параметры: параметры отбора назначений. Можно передать пустую структуру для получения всех назначений. Доступны параметры:
- КартаГостя: карта гостя пациента.
- ФизЛицо: физическое лицо пациента.
- ДокументНазначения: документ назначения.
- фОплата: получить таблицу с оплатой счетов.
- Кабинет: кабинеты, по которым необходимо получить назначения.
- НачалоПериода: начало периода сеансов.
- КонецПериода: конец периода сеансов.
- КатегорияУслуги: получить только услуги переданной категории.
- НаДату: дата документов назначения сеансов.

Пример вызова

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"
}	
}

Пример ответа

[
{
"ДатаСеанса": "2023-03-03T00:00:00",
"ВремяС": "0001-01-01T08:10:00",
"ВремяДо": "0001-01-01T08:30:00",
"Платная": false,
"ПроцентОплаты": 0,
"Пройдено": 0,
"Осталось": 1,
"Назначено": null,
"БлижайшийСеанс": "2023-03-03T00:00:00",
"Комментарий": "",
"КодСтроки": 1,
"ПредставлениеПараметровНазначения": "",
"КартаГостя": {
"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f",
"Наименование": null,
"Код": null,
"Дата": "2023-03-03T09:15:21",
"Номер": "23/00011       "
},
"Пациент": {
"Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=980360a44c379a5b11e6913943daceb3",
"Наименование": "Романов Игорь Егорович",
"Код": "dem0000014",
"Дата": null,
"Номер": null
},
"Услуга": {
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=b20b6451060d98bd11e5bc5b3068e44c",
"Наименование": "Исследование времени кровотечения",
"Код": "t01000111",
"Дата": null,
"Номер": null,
"Памятка": ""
},
"ПараметрыНазначения": {
"Идентификатор": "e1cib/data/Документ.яъЗначенияСвойств?ref=00000000000000000000000000000000",
"Наименование": null,
"Код": null,
"Дата": "0001-01-01T00:00:00",
"Номер": ""
},
"Кабинет": {
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6735a8e750",
"Наименование": "210 - Лаборатория",
"Код": "210",
"Дата": null,
"Номер": null
},
"Оборудование": {
"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=b20b6451060d98bd11e5babd8df939f8",
"Наименование": "Лаборатория",
"Код": "00000000011",
"Дата": null,
"Номер": null
},
"ДокументНазначения": {
"Идентификатор": "e1cib/data/Документ.НазначениеУслуг?ref=94fda85e4511756911edb9bb423b531f",
"Наименование": null,
"Код": null,
"Дата": "2023-03-03T16:42:13",
"Номер": "demA00698      "
}
}
]

ПоказателиПациента

Значения показателей пациента по физическому лицу.

Параметры:

ФизЛицо: физическое лицо, по которому необходимо получить показатели.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ПоказателиПациента&ФизЛицо={"Идентификатор":"e1cib/data/Справочник.яъФизическиеЛица?ref=b20b6451060d98bd11e59cb642414f2b"}

Пример ответа

[
{
"Показатель": "Группа не указана",
"Значение": null,
"ГруппаПоказателей": null
},
{
"Показатель": "Объём мочи, суточный",
"Значение": "10",
"ГруппаПоказателей": ""
},
{
"Показатель": "Диета",
"Значение": "ОВД - основной вариант стандартной диеты",
"ГруппаПоказателей": ""
},

{
"Показатель": "Хирургические вмешательства",
"Значение": "полипэктомия",
"ГруппаПоказателей": "Анамнез"
},
{
"Показатель": "Онкологический анамнез",
"Значение": "c-r легкого",
"ГруппаПоказателей": "Анамнез"
},
{
"Показатель": "Сахарный диабет",
"Значение": "нет",
"ГруппаПоказателей": "Анамнез"
},
{
"Показатель": "Инфекционные заболевания",
"Значение": "туберкулез",
"ГруппаПоказателей": "Анамнез"
},
{
"Показатель": "Анамнез",
"Значение": "полиартроз",
"ГруппаПоказателей": "Анамнез"
},
{
"Показатель": "Анамнез",
"Значение": null,
"ГруппаПоказателей": null
}
]

ОказанныеУслуги

Оказанные услуги исполнителя.

Параметры:

НачалоПериода: начало периода оказанных услуг.
КонецПериода: конец периода оказанных услуг.
Исполнитель: исполнитель услуг.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ОказанныеУслуги&Параметры={"НачалоПериода":"2022-01-14T00:00:00","КонецПериода":"2023-01-18T00:00:00","Исполнитель":{"Идентификатор":"e1cib/data/Справочник.Сотрудники?ref=b20b6451060d98bd11e5a7ef357c1a80"}}

Пример ответа

{
[
{
"Услуга": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Массаж ручной",
"Код": "t01000063",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "Процедуры",
"Наименование": "Процедуры",
"Код": "000000002",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4635"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0535bff3f1"
},
"ПроцЕд": 18,
"Стоимость": 2098,
"Выполнено": 3,
"Платная": true
},
{
"Услуга": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Ароматерапия",
"Код": "t01000067",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "Процедуры",
"Наименование": "Процедуры",
"Код": "000000002",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4635"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70"
},
"ПроцЕд": 50,
"Стоимость": 10165,
"Выполнено": 4,
"Платная": true
},
{
"Услуга": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Ароматерапия",
"Код": "t01000067",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "Процедуры",
"Наименование": "Процедуры",
"Код": "000000002",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4635"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70"
},
"ПроцЕд": 5,
"Стоимость": 55,
"Выполнено": 1,
"Платная": false
}
]

ИзменитьСостояниеСеанса

Создание документа «Отметка услуг».

Тело запроса (обязательные параметры):

фОтмена: если истина, то вид документа будет «Неявка на услуги», иначе «Отметка услуг».
Дата: дата оказания услуги.
Услуга: услуга для оказания.
Пациент: физическое лицо или карта гостя пациента.
Кабинет: кабинет оказания услуги.
ДокументНазначения: документ назначения услуги, по которому необходимо выполнить отметку.
КодСтроки: код строки услуги из документа назначения.

Тело запроса (необязательные параметры):

Исполнитель: исполнитель услуг. Значение по умолчанию - текущий пользователь.
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
}

Пример ответа

{
"Success": true,
"Result": true,
"Messages": []
}

Подсистема «Предприятие»

GetPaymentQRCode

Формирует и возвращает QR-код для оплаты счета. Может вернуть как структуру из разных видов QR-кодов, так и просто ссылку на него.

Параметры:

ТипКода: тип необходимого QR-кода. Поддерживаются "СБП" и "Обычный".
СчетНаОплату: структура, описывающая счёт на оплату, или содержащая ссылку на уже существующий.

Пример вызова

/GetPaymentQRCode?ТипКода=["СБП", "Обычный"]&СчетНаОплату={"Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc434d07efc77"}

Пример ответа

{
    "Success": true,
    "Result": {
        "СБП": "https://test.ecom.raiffeisen.ru/api/sbp/v1/qr/AD241848FF8A4D0E9700D707C7688152/image",
        "Обычный": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKoAAACqAQAAAAAVDekvAAAEEUlEQVR4AdWVsYo0OQyEBUoFehWBUoNe3aDU4FcRODX4anr+5GDcl/7nHdidr9m2LZWq6Pxa/X+Aic9pS8+stXaYzaK441ihTdssG5nM6X5esPloNcMFT+l0U+dXbNTGmDhqP3vHf+Ha85DPPg2PtL/iWNqzQmt8fk33dV4wsf97Gb3gczKUwgSbr9WWxJ96/8RkatlQXq6OY5qM8YIl+LSeduKI7pzHWtyxU7fueAtlWmbpjHPHPXw3PjbDJq+9stoLJqw9nVorzY4H8ynsBbum4+fEPttyoHHtBZvT2nsb0zgDYhPJc8c020dgaLHNNWYWZHrHm6PlWV1i01lppiPu2AbKSek6SQulOH2+4ODsutuw2hvtNYl6wbMZY4xK+qObqnwKe8GNLU21f6dwRCm94ICG5wrhOUdlUGrEC+aOwrbEsB5p3M56trzgpcOWq+1TvFpGbH7BQZTUiVS5E49RpC8YYjOCeezwrMI74g0PNzuY6KrJn7lmf8MSaLGEjGNcyhhtiTsO0miFA24vFlyP7Hvun9gw2bMHT4zgthBII+74M0cxx1w0h+rc1urp/G+89YQr5JMinrbm1wou+NCqOPsc2Qnhb1n2gufABbbKoeHNVW09grjgglNHX7h45yIW4cc4Lhizhz/IGkRPEeZ7v+BmuqCxJZSxDHpmesFzts895m6QPiImxrewvzH6ajJHdniMsO8ezwEv2Df+beSaxCpt79nOC962MHMbhgS3YVhZ0QvOjcNNQklhNpvxfL5gR0wMiKEMN4KjaT5tuOBonZrCAY5taSTQ3AueVo/BoMLBC/b4Da8LhmXAW/pe4zhySVW/efkbb8J8ChRkE+EVa5GcO068hSEEbPzJl2VhL7g8DpO7DojeW32+37FDYs3R11a5/GwYYNzxZ1pxQEV2wJSSmd4wq8/WRIWr+U5p7WnaBcOGCqVfPSPFKukr+wsuRe2PpPKY2L0Jr7hjdqsxp7jy3Ar/mk9hLziRACrl7eCDMD9TXzAlahQdgqgc7hY46R1jD28f47XNhiGEil7wrmD3pEVZmL5CsV6wI0CrNjyxMscqVPncMcIoNxxJjPBloFb9BUdgO5PToKKdKWM9W16w5Gf4h69eiH8ocz5iu+AlsdgR6BunRNJBdW+4wz8P3EbHR/6ntf6Co43h3FxGnzInZvaR5gVDMxlHEDAj9t6Yl3rBeItMSpeDKEKmbn0OeMHdcFnFRGsYcz/IyBd8jlb2UFjpqnSa8Qjigom9kzjDelFV3s0fK7jgQIeJA5cpGEfXFl8L+40NdZIks8MwJUG+PLK/4ijIQXazI6hEfCP6imlkIuu6oP6BTJUXHEsw2+aolC5Fs9cT6BdMjPGevKC32Rsu9RXbBf9afz/+BxyWHQ86YHDJAAAAAElFTkSuQmCC"
    }
}

GetAcceptances

Доступен с версии 21.07.01

Возвращает перечень созданных приёмов платежей по контрагенту, договору и/или счету (в зависимости от переданных параметров).

Пример вызова

/GetData?Method=GetAcceptances&Контрагент={"ID":%20"e1cib/data/Справочник.Контрагенты?ref=9a6c5404a66e4a8911e5bb8e2aa076f5"}&Счет={"Идентификатор":%20"e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc434d07efc5d"}&Реквизиты=СуммаДокументаБезСкидки

Пример ответа

{
    "Success": true,
    "Result": [
        {
            "Дата": "2019-09-30T15:26:39",
            "Номер": "ЧО0000000000038",
            "Идентификатор": "e1cib/data/Документ.ПриемПлатежей?ref=b48b5404a66e4a8911e9e36cba1ce639",
            "СуммаДокументаБезСкидки": 1000
        },
        {
            "Дата": "2021-06-03T10:54:18",
            "Номер": "ЧО000000149    ",
            "Идентификатор": "e1cib/data/Документ.ПриемПлатежей?ref=b4bd5404a66e4a8911ebc434d07efc5b",
            "СуммаДокументаБезСкидки": 21109
        },
        {
            "Дата": "2021-06-03T11:16:05",
            "Номер": "ЧО000000150    ",
            "Идентификатор": "e1cib/data/Документ.ПриемПлатежей?ref=b4bd5404a66e4a8911ebc434d07efc61",
            "СуммаДокументаБезСкидки": 3885
        }
    ]
}

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"}
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2023-10-13T15:10:45",
"Номер": "23/00094       ",
"Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=9511a85e4511756911ee69b9254871ae"
},
"Messages": [
{
"text": "15:10:51: сообщение отправлено на test.test@gmail.com"
}
]
}

Счет на оплату на 10 единиц номенклатуры.

{
"Контрагент": {"ID": "e1cib/data/Справочник.Контрагенты?ref=9510a85e4511756911ee52ea8a5111a5"},
"Договор": {"ID": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=9510a85e4511756911ee52ea8a5111a6"},
"Основание": {"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=9511a85e4511756911ee698a1ac22021"},
"мсУслуги": [
{
"Номенклатура": {"ID": "e1cib/data/Справочник.Номенклатура?ref=9a4e60a44c379a5b11e9b3808b34f6b5"},
"Количество": 10
}
]
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2023-10-13T15:45:47",
"Номер": "23/00095       ",
"Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=9511a85e4511756911ee69be0a6345ae"
},
"Messages": []
}

RegisterPayment

Доступен с версии 21.07.01

Создаёт приём платежей. Должен быть строго POST-запросом. В теле должны содержаться данные для добавления в документ. Основными считаются ссылка на счёт-основание, вид документа и сумма. Все остальные должны передаваться внутри объекта "Контекст".

Пример запроса

{
    "Счет": {"Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc42b9401edbb"},
    "ВидДокумента": "ПриемПлатежей",
    "Сумма": 100,
    "Контекст": {
        "ЧекПробитВоВнешнейПрограмме": true,
        "НомерВходящегоДокумента": "000002",
        "ДатаВходящегоДокумента": "2021-07-13T13:33:59"
    }
}

Пример ответа

{
    "Success": true,
    "Result": {
        "Дата": "2021-07-14T10:07:23",
        "Номер": "ЧО000000162    ",
        "Идентификатор": "e1cib/data/Документ.ПриемПлатежей?ref=967f708bcda2156111ebe469c0d8a16b"
    }
}

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=СуммаДокумента

Пример ответа

{
    "Success": true,
    "Result": [
        {
            "Дата": "2021-06-03T10:54:11",
            "Номер": "ЧОКУС-000000120",
            "Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc434d07efc5a",
            "СуммаДокумента": 25000   
        },
        {
            "Дата": "2021-06-03T10:54:43",
            "Номер": "ЧОКУС-000000121",
            "Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc434d07efc5d",
            "СуммаДокумента": 10000
        }
    ]
}

RoomCleaningStatus

Состояние уборки помещений.

Необязательные параметры:

Исполнитель: исполнитель потребностей. Если не указан, то состояние будет получено по текущему пользователю.
НаДату: дата уборки. Если не указана, то состояние будет получено на текущую дату.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=RoomCleaningStatus&НаДату=06.03.2023&Исполнитель={"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=94fda85e4511756911edb9bb423b532c"}

Пример ответа

{
"Success": true,
"Result": [
{
"Помещение": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "2102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0f1"
},
"БлижайшийЗаезд": null,
"БлижайшийВыезд": null,
"ТребуетсяУборка": true,
"КоличествоПотребностей": 1,
"УборкаЗаездВыезд": false
}
],
"Messages": []
}

ListRooms

Перечень помещений и категорий.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ListRooms

Пример ответа

{
"Success": true,
"Result": {
"мзЗдания": [
{
"Ссылка": {
"ПометкаУдаления": true,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Лечебный корпус",
"Код": "dem000003",
"Идентификатор": "e1cib/data/Справочник.Здания?ref=8d2260a44c379a5b11e7a4e84ad54bf3"
},
"яъОрганизация": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Санаторий \"Родные просторы\"",
"Код": "9999999/2",
"Идентификатор": "e1cib/data/Справочник.Организации?ref=9bc8e4800e39484c4b1e680675db5963"
}
}
],
"мзКатегорииПомещений": [
{
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "НомерГостиницы",
"Наименование": "Гостиничный номер",
"Идентификатор": "e1cib/data/Справочник.яъКатегории?ref=9b7996e6d857ebf811e3a8f3c11af030"
}
]
},
"Messages": []
}

ПереченьПотребностей

Список потребностей и их исполнителей.

Необязательные параметры:

НаДату: дата потребности. Если не указана, то список потребностей будет получен на текущую дату.
Исполнитель: пользователь исполнителя потребности.
Помещение: помещение исполнения потребности.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ПереченьПотребностей&НаДату=06.03.2023&Исполнитель={"Идентификатор": "e1cib/data/Справочник.яъПользователи?ref=94fda85e4511756911edb9bb423b532c"}

Пример ответа

{
"Success": true,
"Result": [
{
"РаботаУслуга": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Генеральная уборка (Стандарт)",
"Код": "dem000009",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Услуги клининга",
"Код": "dem000005",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=9cb960a44c379a5b11e739694d098bb1"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=9cb960a44c379a5b11e73fb6d9cf78e0"
},
"Помещение": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "2102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0f1"
},
"Исполнитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Нина Егоровна",
"Код": "t010000053",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Горничные",
"Код": "dem0000005",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=9cb960a44c379a5b11e73fb950120f70"
},
"Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=9a0660a44c379a5b11e7e0930feffd50"
},
"Date": "2023-03-06T00:00:00",
"ВремяС": "0001-01-01T00:00:00",
"ВремяДо": "0001-01-01T00:00:00",
"Основание": {
"Дата": "2023-03-06T09:58:22",
"Номер": "dem000042      ",
"Идентификатор": "e1cib/data/Документ.НарядНаРаботы?ref=94fda85e4511756911edb9bb423b532b"
},
"Ссылка": {
"Дата": "2023-03-06T09:58:22",
"Номер": "dem000042      ",
"Идентификатор": "e1cib/data/Документ.НарядНаРаботы?ref=94fda85e4511756911edb9bb423b532b"
},
"КодСтроки": 1,
"Выполнено": false
}
],
"Messages": []
}

ЗаписатьУдостоверениеФизлица

Создание основного удостоверения физического лица.

Параметры:

ФизЛицо: владелец удостоверения.

Тело запроса (обязательные параметры):

ВидДокумента: вид документа удостоверения.

Тело запроса (необязательные параметры):

ДокументСерия: серия документа.
ДокументНомер: номер документа.
ДокументДатаВыдачи: дата выдачи документа.
ДокументКемВыдан: кем выдан документ.
ДокументКодПодразделения: код подразделения документа.
ДатаРегистрацииПоМестуЖительства: дата регистрации по месту жительства.
ДействителенДо: дата окончания действия документа.
ТипВизы: код типа визы МВД.
КратностьВизы: код кратности визы МВД.
ЦельВъезда: код цели въезда по визе МВД.
КодПунктаПересечения: код пункта пересечения границы.
ПунктПересеченияГраницы: пункт пересечения границы.
ФилиалФСС: номер филиала ФСС.
НомерСтрахователя: регистрационный номер страхователя.
ОкончаниеРегистрации: дата окончания регистрации.
ТипПолисаОМС: тип полиса ОМС.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ЗаписатьУдостоверениеФизлица&ФизЛицо={"Идентификатор":"e1cib/data/Справочник.яъФизическиеЛица?ref=b20b6451060d98bd11e59cb642414f2b"}

Тело запроса

{
"ВидДокумента": {"Идентификатор": "e1cib/data/Справочник.ДокументыУдостоверяющиеЛичность?ref=846e60a44c379a5b11e55885c749b7e0"},
"ДокументСерия": 9518,
"ДокументНомер": 648334,
"ДокументДатаВыдачи": "2014-05-18T00:00:00",
"ДокументКемВыдан": "КИНТ",
"ДокументКодПодразделения": 162566
}

Пример ответа

{
"Success": true,
"Result": null,
"Messages": []
}

РасходныеПоПомещению

Список расходных материалов по помещениям.

Необязательные параметры:

ДокументНазначения: документ назначения, по которому необходимо получить расходные материалы.
Услуга: услуга(работа), по которой были добавлены расходные материалы.
ПараметрыНазначения: параметры назначения услуги, по которой были добавлены расходные материалы.
ОбъектРабот: помещение, по которому необходимо получить расходные материалы.
фПлатная: отбор только по платным/бесплатным услугам.
ДатаТребования/ДатаСеанса: дата требования.
КодСтроки: код строки требования.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=РасходныеПоПомещению&ДатаТребования=06.03.2023&ДокументНазначения={"Идентификатор": "e1cib/data/Документ.НарядНаРаботы?ref=94fda85e4511756911edb9bb423b532b"}

Пример ответа

{
"Success": true,
"Result": [
{
"Документ": {
"Дата": "2023-03-06T09:58:22",
"Номер": "dem000042      ",
"Идентификатор": "e1cib/data/Документ.НарядНаРаботы?ref=94fda85e4511756911edb9bb423b532b"
},
"Организация": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Санаторий \"Родные просторы\"",
"Код": "9999999/2",
"Идентификатор": "e1cib/data/Справочник.Организации?ref=9bc8e4800e39484c4b1e680675db5963"
},
"ОсновнойСклад": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"ЭтоГруппа": null,
"Идентификатор": "e1cib/data/Справочник.Склады?ref=00000000000000000000000000000000"
},
"СкладПроизводства": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"ЭтоГруппа": null,
"Идентификатор": "e1cib/data/Справочник.Склады?ref=00000000000000000000000000000000"
},
"НаборУслуг": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"ЭтоГруппа": null,
"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=00000000000000000000000000000000"
},
"Номенклатура": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Шампунь одноразовый",
"Код": "00000000001",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "лимитка и профхимия",
"Код": "dem00000014",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Расходные материалы",
"Код": "dem00000001",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=997960a44c379a5b11e62e032ea50ab3"
},
"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=9a6f60a44c379a5b11ec593317b72b6c"
},
"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=9a5560a44c379a5b11ea2572d42b3184"
},
"ОбъектРабот": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "102",
"Код": "2102",
"ЭтоГруппа": false,
"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0f1"
},
"ДатаТребования": "2023-03-06T00:00:00",
"Qty": 1,
"ДокументНазначения": {
"Дата": "2023-03-06T09:58:22",
"Номер": "dem000042      ",
"Идентификатор": "e1cib/data/Документ.НарядНаРаботы?ref=94fda85e4511756911edb9bb423b532b"
},
"Услуга": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Генеральная уборка (Стандарт)",
"Код": "dem000009",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Услуги клининга",
"Код": "dem000005",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=9cb960a44c379a5b11e739694d098bb1"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=9cb960a44c379a5b11e73fb6d9cf78e0"
},
"ПараметрыНазначения": {
"Дата": "0001-01-01T00:00:00",
"Номер": "",
"Идентификатор": "e1cib/data/Документ.яъЗначенияСвойств?ref=00000000000000000000000000000000"
},
"ОбластьПрименения": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"ЭтоГруппа": null,
"Идентификатор": "e1cib/data/Справочник.ОбластиПрименения?ref=00000000000000000000000000000000"
},
"фПлатная": false,
"Исполнитель": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"ЭтоГруппа": null,
"Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=00000000000000000000000000000000"
},
"КодСтроки": 1
}
],
"Messages": []
}

Модуль «Питание»

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"}

Пример ответа

[
{
"Рацион": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Завтрак",
"Код": "000000006",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "УслугиПитания",
"Наименование": "Услуги питания",
"Код": "000000003",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4634"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d0"
},
"Блюдо": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Айран (молочный напиток — кабардино-балкарское национальное блюдо) №731",
"Код": "00000000310",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Молочные и сливочные прохладительные напитки",
"Код": "00000000309",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Напитки",
"Код": "00000000007",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=ac2360a44c379a5b11e566724d4c46e0"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37ca294268"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37ca294269"
},
"ВидБлюда": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"Идентификатор": "e1cib/data/Справочник.дтВидыБлюд?ref=00000000000000000000000000000000"
},
"Количество": 1
},
{
"Рацион": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Обед",
"Код": "000000007",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "УслугиПитания",
"Наименование": "Услуги питания",
"Код": "000000003",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4634"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d1"
},
"Блюдо": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Баранина отварная с овощами №396",
"Код": "00000000703",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Отварное мясо, субпродукты",
"Код": "00000000697",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Блюда из мяса и мясных продуктов",
"Код": "00000000010",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "БЛЮДА",
"Код": "9          ",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=9a4a60a44c379a5b11e936657263abfc"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec34aacac6a2"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d61e6be7"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d61e6bed"
},
"ВидБлюда": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"Идентификатор": "e1cib/data/Справочник.дтВидыБлюд?ref=00000000000000000000000000000000"
},
"Количество": 1
}
]

БлюдаДляЗаказа

Доступные для заказа блюда.

Параметры:

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

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=БлюдаДляЗаказа&Параметры={"НаДату": "04.03.2023", "ВариантПитания": {"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=9b7996e6d857ebf811e3a8f3d747934e"}}

Пример ответа

[
{
"Рацион": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Завтрак",
"Код": "000000006",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "УслугиПитания",
"Наименование": "Услуги питания",
"Код": "000000003",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4634"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d0"
},
"ВидБлюда": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"Идентификатор": "e1cib/data/Справочник.дтВидыБлюд?ref=00000000000000000000000000000000"
},
"Блюдо": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Айран (молочный напиток — кабардино-балкарское национальное блюдо) №731",
"Код": "00000000310",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Молочные и сливочные прохладительные напитки",
"Код": "00000000309",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Напитки",
"Код": "00000000007",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=ac2360a44c379a5b11e566724d4c46e0"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37ca294268"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37ca294269"
},
"Количество": 1,
"МаксКоличество": null
},
{
"Рацион": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Завтрак",
"Код": "000000006",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "УслугиПитания",
"Наименование": "Услуги питания",
"Код": "000000003",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4634"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d0"
},
"ВидБлюда": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"Идентификатор": "e1cib/data/Справочник.дтВидыБлюд?ref=00000000000000000000000000000000"
},
"Блюдо": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Апельсины с сахаром №630",
"Код": "00000000487",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Плоды и ягоды свежие и быстрозамороженные",
"Код": "00000000480",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Сладкие блюда",
"Код": "00000000341",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37ca294288"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d023d712"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d023d719"
},
"Количество": 1,
"МаксКоличество": null
},
{
"Рацион": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Обед",
"Код": "000000007",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "УслугиПитания",
"Наименование": "Услуги питания",
"Код": "000000003",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4634"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d1"
},
"ВидБлюда": {
"ПометкаУдаления": null,
"Предопределенный": null,
"ИмяПредопределенныхДанных": null,
"Наименование": null,
"Код": null,
"Идентификатор": "e1cib/data/Справочник.дтВидыБлюд?ref=00000000000000000000000000000000"
},
"Блюдо": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Баранина отварная с овощами №396",
"Код": "00000000703",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Отварное мясо, субпродукты",
"Код": "00000000697",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Блюда из мяса и мясных продуктов",
"Код": "00000000010",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "БЛЮДА",
"Код": "9          ",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=9a4a60a44c379a5b11e936657263abfc"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec34aacac6a2"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d61e6be7"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d61e6bed"
},
"Количество": 1,
"МаксКоличество": null
},
{
"Рацион": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Ужин",
"Код": "000000008",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "УслугиПитания",
"Наименование": "Услуги питания",
"Код": "000000003",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab41cc1f4634"
},
"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d2"
},
"ВидБлюда": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Гарнир",
"Код": 5,
"Идентификатор": "e1cib/data/Справочник.дтВидыБлюд?ref=bf4e60a44c379a5b11e61cf626926640"
},
"Блюдо": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Баклажаны жареные №548",
"Код": "00000000671",
"ЭтоГруппа": false,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Гарниры из картофеля и овощей",
"Код": "00000000619",
"ЭтоГруппа": true,
"Родитель": {
"ПометкаУдаления": false,
"Предопределенный": false,
"ИмяПредопределенныхДанных": "",
"Наименование": "Гарниры",
"Код": "00000000601",
"ЭтоГруппа": true,
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d023d78b"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d023d79d"
},
"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37d61e6bcd"
},
"Количество": 1,
"МаксКоличество": null
}
]

тзУФО_Меню

Документ «Меню-раскладка» на дату.

Параметры:

Параметры: структура, содержащая:
- Дата: дата меню.
- ВариантПитания: вариант питания, для которого было составлено меню.
- Диета: диета, для которой было составлено меню.

Пример вызова

http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=тзУФО_Меню&Параметры={"Дата":"2023-03-17T00:00:00","Диета":"","ВариантПитания":{"Идентификатор":"e1cib/data/Справочник.НаборыУслуг?ref=9b7996e6d857ebf811e3a8f3d747934e"}}

Пример ответа

[
{
"Калорийность": 162.34,
"БелкиОбщ": 8.12,
"ЖирыОбщ": 0.68,
"УглевОбщ": 30.44,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0.27,
"ВитаминВ2": 0.34,
"ВитаминРР": 4.06,
"ВитаминС": 33.82,
"Железо": 2.71,
"Калий": 1609.83,
"Кальций": 101.46,
"Магний": 60.88,
"Натрий": 40.58,
"Фосфор": 229.98,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Баклажаны (свежие)",
"Блюдо": "Баклажаны тушеные с помидорами в соусе \"Восточный\" №106",
"ВидБлюда": "Гарнир",
"ВыходФакт": 1000,
"ВыходБлюда": 1000,
"КоличествоПродуктаОборот": 2136,
"Рацион": "Завтрак",
"ПорядокРациона": "000000006",
"Брутто": 2136,
"Нетто": 2029.2,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 674.25,
"БелкиОбщ": 0,
"ЖирыОбщ": 74.93,
"УглевОбщ": 0,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0,
"ВитаминВ2": 0,
"ВитаминРР": 0,
"ВитаминС": 0,
"Железо": 0,
"Калий": 0,
"Кальций": 0,
"Магний": 0,
"Натрий": 0,
"Фосфор": 1.5,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Масло растительное",
"Блюдо": "Баклажаны тушеные с помидорами в соусе \"Восточный\" №106",
"ВидБлюда": "Гарнир",
"ВыходФакт": 1000,
"ВыходБлюда": 1000,
"КоличествоПродуктаОборот": 225,
"Рацион": "Завтрак",
"ПорядокРациона": "000000006",
"Брутто": 225,
"Нетто": 225,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 134.4,
"БелкиОбщ": 6.16,
"ЖирыОбщ": 1.12,
"УглевОбщ": 21.28,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0.34,
"ВитаминВ2": 0.22,
"ВитаминРР": 2.97,
"ВитаминС": 140,
"Железо": 5.04,
"Калий": 1624,
"Кальций": 78.4,
"Магний": 112,
"Натрий": 16.8,
"Фосфор": 145.6,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Помидоры свежие",
"Блюдо": "Баклажаны тушеные с помидорами в соусе \"Восточный\" №106",
"ВидБлюда": "Гарнир",
"ВыходФакт": 1000,
"ВыходБлюда": 1000,
"КоличествоПродуктаОборот": 1680,
"Рацион": "Завтрак",
"ПорядокРациона": "000000006",
"Брутто": 1680,
"Нетто": 1680,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 0,
"БелкиОбщ": 0,
"ЖирыОбщ": 0,
"УглевОбщ": 0,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0,
"ВитаминВ2": 0,
"ВитаминРР": 0,
"ВитаминС": 0,
"Железо": 0,
"Калий": 0,
"Кальций": 0,
"Магний": 0,
"Натрий": 0,
"Фосфор": 0,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Соус “Восточный”",
"Блюдо": "Баклажаны тушеные с помидорами в соусе \"Восточный\" №106",
"ВидБлюда": "Гарнир",
"ВыходФакт": 1000,
"ВыходБлюда": 1000,
"КоличествоПродуктаОборот": 600,
"Рацион": "Завтрак",
"ПорядокРациона": "000000006",
"Брутто": 600,
"Нетто": 600,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 0,
"БелкиОбщ": 0.85,
"ЖирыОбщ": 0.07,
"УглевОбщ": 0,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0.01,
"ВитаминВ2": 0.01,
"ВитаминРР": 0.16,
"ВитаминС": 1.3,
"Железо": 0.2,
"Калий": 33.8,
"Кальций": 23.4,
"Магний": 3.9,
"Натрий": 2.21,
"Фосфор": 13,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Чеснок",
"Блюдо": "Баклажаны тушеные с помидорами в соусе \"Восточный\" №106",
"ВидБлюда": "Гарнир",
"ВыходФакт": 1000,
"ВыходБлюда": 1000,
"КоличествоПродуктаОборот": 39,
"Рацион": "Завтрак",
"ПорядокРациона": "000000006",
"Брутто": 39,
"Нетто": 39,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 166.5,
"БелкиОбщ": 12.58,
"ЖирыОбщ": 12.88,
"УглевОбщ": 0,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0.04,
"ВитаминВ2": 0.15,
"ВитаминРР": 3.48,
"ВитаминС": 0,
"Железо": 2,
"Калий": 240.5,
"Кальций": 6.66,
"Магний": 16.28,
"Натрий": 48.1,
"Фосфор": 139.12,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Говядина (вырезка)",
"Блюдо": "Биточки говяжьи паровые №475",
"ВидБлюда": "Первые блюда",
"ВыходФакт": 100,
"ВыходБлюда": 100,
"КоличествоПродуктаОборот": 303,
"Рацион": "Обед",
"ПорядокРациона": "000000007",
"Брутто": 303,
"Нетто": 222,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 26.44,
"БелкиОбщ": 0.03,
"ЖирыОбщ": 2.9,
"УглевОбщ": 0.05,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0.02,
"ВитаминВ1": 0,
"ВитаминВ2": 0,
"ВитаминРР": 0,
"ВитаминС": 0,
"Железо": 0.01,
"Калий": 1.2,
"Кальций": 0.96,
"Магний": 0,
"Натрий": 0.6,
"Фосфор": 1.2,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Масло сливочное",
"Блюдо": "Биточки говяжьи паровые №475",
"ВидБлюда": "Первые блюда",
"ВыходФакт": 100,
"ВыходБлюда": 100,
"КоличествоПродуктаОборот": 12,
"Рацион": "Обед",
"ПорядокРациона": "000000007",
"Брутто": 12,
"Нетто": 12,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 13.86,
"БелкиОбщ": 0.66,
"ЖирыОбщ": 0.77,
"УглевОбщ": 1.03,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0,
"ВитаминВ2": 0.03,
"ВитаминРР": 0.02,
"ВитаминС": 0.13,
"Железо": 0.02,
"Калий": 32.12,
"Кальций": 26.62,
"Магний": 3.08,
"Натрий": 11,
"Фосфор": 20.02,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Молоко",
"Блюдо": "Биточки говяжьи паровые №475",
"ВидБлюда": "Первые блюда",
"ВыходФакт": 100,
"ВыходБлюда": 100,
"КоличествоПродуктаОборот": 66,
"Рацион": "Обед",
"ПорядокРациона": "000000007",
"Брутто": 66,
"Нетто": 66,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 42.3,
"БелкиОбщ": 1.42,
"ЖирыОбщ": 0.18,
"УглевОбщ": 8.69,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0.03,
"ВитаминВ2": 0.01,
"ВитаминРР": 0.29,
"ВитаминС": 0,
"Железо": 0.36,
"Калий": 23.94,
"Кальций": 4.14,
"Магний": 5.94,
"Натрий": 68.04,
"Фосфор": 15.66,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Хлеб пшеничный",
"Блюдо": "Биточки говяжьи паровые №475",
"ВидБлюда": "Первые блюда",
"ВыходФакт": 100,
"ВыходБлюда": 100,
"КоличествоПродуктаОборот": 54,
"Рацион": "Обед",
"ПорядокРациона": "000000007",
"Брутто": 54,
"Нетто": 54,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 307.57,
"БелкиОбщ": 15.38,
"ЖирыОбщ": 1.28,
"УглевОбщ": 57.67,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0.51,
"ВитаминВ2": 0.64,
"ВитаминРР": 7.69,
"ВитаминС": 64.08,
"Железо": 5.13,
"Калий": 3050.09,
"Кальций": 192.23,
"Магний": 115.34,
"Натрий": 76.89,
"Фосфор": 435.73,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Баклажаны (свежие)",
"Блюдо": "Баклажаны жареные №548",
"ВидБлюда": "Гарнир",
"ВыходФакт": 1000,
"ВыходБлюда": 1000,
"КоличествоПродуктаОборот": 4047,
"Рацион": "Ужин",
"ПорядокРациона": "000000008",
"Брутто": 4047,
"Нетто": 3844.65,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 539.4,
"БелкиОбщ": 0,
"ЖирыОбщ": 59.94,
"УглевОбщ": 0,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0,
"ВитаминВ2": 0,
"ВитаминРР": 0,
"ВитаминС": 0,
"Железо": 0,
"Калий": 0,
"Кальций": 0,
"Магний": 0,
"Натрий": 0,
"Фосфор": 1.2,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Масло растительное",
"Блюдо": "Баклажаны жареные №548",
"ВидБлюда": "Гарнир",
"ВыходФакт": 1000,
"ВыходБлюда": 1000,
"КоличествоПродуктаОборот": 180,
"Рацион": "Ужин",
"ПорядокРациона": "000000008",
"Брутто": 180,
"Нетто": 180,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
},
{
"Калорийность": 165,
"БелкиОбщ": 5.3,
"ЖирыОбщ": 0.65,
"УглевОбщ": 34.5,
"БелкиЖивотн": 0,
"ЖирыРаст": 0,
"ВитаминА": 0,
"ВитаминВ1": 0.13,
"ВитаминВ2": 0.04,
"ВитаминРР": 1.1,
"ВитаминС": 0,
"Железо": 1.05,
"Калий": 89,
"Кальций": 12,
"Магний": 22,
"Натрий": 2,
"Фосфор": 57.5,
"МенюРаскладка": "Меню-раскладка 000000000000003 от 16.03.2023 (Основное требование)",
"Продукт": "Мука пшеничная",
"Блюдо": "Баклажаны жареные №548",
"ВидБлюда": "Гарнир",
"ВыходФакт": 1000,
"ВыходБлюда": 1000,
"КоличествоПродуктаОборот": 150,
"Рацион": "Ужин",
"ПорядокРациона": "000000008",
"Брутто": 150,
"Нетто": 150,
"КоличествоПорций": 3,
"Коэффициент": "",
"ПлановоеМеню": "",
"ЕдиницаИзмеренияВБлюде": "г",
"фОбработана": true
}
]

ЗаказатьБлюда

Создание документа «Задача» в процессе «Заказ питания».

Тело запроса (обязательные параметры):

Заявитель: карта гостя заказчик блюд.
НаДату: срок исполнения заказа.
мсБлюда: массив структур с блюдами для заказа, содержащих:
- Услуга: услуга (рацион).
- Потребность: блюдо для заказа.
- Количество: количество блюда для заказа.

Пример вызова

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
}
]
}

Пример ответа

{
"Success": true,
"Result": true,
"Messages": []
}

Соответствие имен реквизитов

Внутренний	Внешний
Наименование	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.

Учет. Анализ. Управление

Методы

PostDocument

Создание документов переданного вида. Обязательный параметр: Вид - имя документа в дереве метаданных или имя предопределенного элемента справочника яъВидыДокументов (для документов, которые делятся на несколько видов, например документ яъЗаказ).

Поддерживаются следующие виды:

яъЗаказПокупателя
яъЗаказПоставщику
яъЗаказНаПроизводство
ОплатаПлатежнойКартой
ПриходныйКассовыйОрдер
ПоступлениеНаРасчетныйСчет
_ПеремещениеРастений
ПеремещениеРезервов
ИзменениеХарактеристик

Реквизиты документа передаются в теле запроса, для успешного создания и проведения документа должны быть заполнены все реквизиты с типом проверки заполнения Выдавать ошибку. Номер и дата документа заполняются автоматически, если не переданы в запросе. Если в запросе передается номер документа, он должен быть уникальным в пределах информационной базы. Ссылочные реквизиты передаются JSON-структурой с одним из ключевых полей: ID или GUID, значения реквизитов (элементы справочников) должны быть предварительно созданы в информационной базе вручную или методом PostElement.

Пример создания заказа покупателя

/PostData?Method=PostDocument&Вид=яъЗаказПокупателя

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

Если передан параметр СкладРезервирования, товары заказа будут автоматически зарезервированы на переданном складе. Параметр может быть передан в реквизитах шапки или в табличной части:

Если склад указан в табличной части - используется склад из табличной части
Если склад не указан в табличной части - используется склад шапки
Если склад не указан ни в шапке ни в табличной части - товар не резервируется

Тело запроса

{
"Организация": {
"GUID": "8a276db6-ce58-11e5-982d-14dae9b19a48"
},
"идИнтернетЗаказа": "0001",
"Дата": "2020-01-01T00:00:00",
"ОплатаПлатежнойКартой": {
"СуммаДокумента": 500,
"ВидОплаты": {
"ID": "e1cib/data/Справочник.ВидыОплатОрганизаций?ref=98165404a66e4a8111e879fee15001c2"
}
},
"СкладРезервирования": {
"ID": "e1cib/data/Справочник.Склады?ref=8b25a0661889f40541be854e00d95269"
},
"Контрагент": {
"GUID": "3cc7dcfa-930d-11df-b942-001bfc345421"
},
"Товары": [
{
"Номенклатура": {
"GUID": "2b82b757-366b-11e9-982b-5404a66e4a81"
},
"Количество": 10,
"Цена": 150,
}
],
"ДополнительныеСвойства": [
{
"Свойство": "СуммаДоставки",
"Значение": 100
}
]
}

Пример ответа

{
"Success": true,
"Result": {
"Дата": "2020-01-01T00:00:00",
"Номер": "0000--000000045",
"Идентификатор": "e1cib/data/Документ.яъЗаказ?ref=98485404a66e4a8111eaa099a5a5b36d"
}
}

Изменение документов

Для вида документа «яъЗаказПокупателя» поддерживается изменение реквизитов. Для этого в тело запроса необходимо передать параметр Идентификатор (идентификатор заказа возвращается при успешном выполнении метода PostDocument). Реквизиты для изменения рекомендуется передавать в параметре «стРеквизиты», а не в теле запроса, так как реквизиты из тела запроса не всегда изменяются при вызове обработки заполнения документа. Если в запросе передана таблица товаров, позиции будут добавлены к существующим, если позиция уже есть в заказе, будет увеличено количество в строке. Если в запросе передан параметр Режим со значением УдалениеТоваров, количество товара будет уменьшено. В случае, если количество стало меньше или равно нулю, строка из заказа будет удалена. Данный функционал доступен начиная с версии 3.24.04.

Пример запроса для изменения реквизитов «Контрагент» и «Договор»

{
  "Идентификатор": "e1cib/data/Документ.яъЗаказ?ref=bca9d85ed320709611ef2232d2aed537",
  "стРеквизиты": {
    "Контрагент": {
      "Идентификатор": "e1cib/data/Справочник.Контрагенты?ref=9a58f2e8cf1cc29211ea4d76137ec466"
    },
    "ДоговорКонтрагента": {
      "Идентификатор": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=bca6d85ed320709611eeb4f2fc6d1fb8"
    }
  }
}

Пример запроса для уменьшения количества номенклатуры

{
  "Идентификатор": "e1cib/data/Документ.яъЗаказ?ref=9d415404a66e4a8911ef224f2be07e9b",
  "Режим": "УдалениеТоваров",
  "Товары": [
    {
      "Номенклатура": {
        "GUID": "2b82b757-366b-11e9-982b-5404a66e4a81"
      },
      "Количество": "10"
    }
  ]
}

Коды ошибок

Код ошибки (ErrorCode)	Описание
3000	В параметрах не передан вид создаваемого документа.
3001	В параметрах передан вид документа, не поддерживаемый методом.
3002	Не удалось записать созданный документ.
3003	Передан вид документа, отсутствующий в конфигурации.
3004	Не удалось зарезервировать товары заказа покупателя.

@@ Строка 1: / Строка 1: @@
-[[Категория:Обмен данными (КУС)|*20]]
+[[Категория: Интеграция с внешними сервисами|*]]
 {| align="right"
 | __TOC__
@@ Строка 9: / Строка 9: @@
 == Требования ==
 # База, к которой обращаются, должна быть [[1С8:Публикация информационной базы 1С на веб-сервере|опубликована на веб-сервере]].
 ## При публикации базы, должна быть выполнена активация HTTP-сервиса KintAPI.
@@ Строка 305: / Строка 304: @@
 * Формат (не обязательный только в случае получения значения параметра) - доступны значения: DOCX, HTML5, MXL, PDF, TXT, XLS
 * ИмяПараметра (Строка, не обязательный) - если передан, то вернется не печатная форма, а значение переданного параметра. По умолчанию доступны параметры на вкладках «Основные» + «Доступные» + «Дополнительные» в форме настройки печатной формы.
-* стрТипВыходныхДанных (Строка, не обязательный) - может использоваться тип данных Base64 или ДвоичныеДанные, в ином случае возвращает путь к файлу. Значение по умолчанию Base64.
+* стрТипВыходныхДанных (Строка, не обязательный) - может использоваться тип данных Base64 или ДвоичныеДанные, в ином случае возвращает содержимое файла. Значение по умолчанию Base64.
 ;Пример вызова:
@@ Строка 775: / Строка 774: @@
 === ЗаписатьПриложения ===
 * '''Тип HTTP-запроса''': GET/POST
-* '''Описание''': Запись приложений (например, картинок) к объекту
+* '''Описание''': Запись приложений (например, картинок) к объекту. Можно отправлять как массив, так и структуру. Возвращает список индексов созданных приложений.
 {| class="wikitable"
@@ Строка 787: / Строка 786: @@
    |-
-   |<code>Текст</code> / <code>Текст</code>
+   |<code>Владелец</code>
-   |Текст
+  |Да
-   |<code>Текст</code>, <code>Текст</code>
+  |<code>Ссылка на объект</code>
-   |Текст
+  |Владелец приложения
-   |<code>Текст</code>
+  |<code>{"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}</code>
+  |-
+  |<code>Индекс</code>
+  |Нет
+  |<code>Число</code>
+  |С указанным параметром перезаписывает старое приложение
+  |<code>1</code>
+  |-
+  |<code>Файл</code>
+  |Да
+  |<code>Строка</code>
+   |Данные файла в Base64-строке
+   |<code>"/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."</code>
+  |-
+  |<code>Представление</code>
+  |Да
+  |<code>Строка</code>
+  |Имя файла с расширением
+  |<code>Арбуз.png</code>
+  |-
+  |<code>яъКомментарий</code>
+  |Нет
+  |<code>Строка</code>
+   |Комментарий приложения
+   |<code>Создан из приложения «Кинт: Мобильный ТСД»</code>
 |}
+* Пример вызова
+*; <pre>/GetData?Method=ЗаписатьПриложения&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Файл="/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBxMTEhUTExMV..."&Представление=Арбуз.png</pre>
+Пример ответа:
+<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
+    [
+        {
+            "Индекс": 11
+        }
+    ]
+</pre>
 === УдалитьПриложение ===
@@ Строка 808: / Строка 850: @@
    |-
-   |<code>Текст</code> / <code>Текст</code>
+   |<code>Владелец</code>
-   |Текст
+  |Да
-   |<code>Текст</code>, <code>Текст</code>
+  |<code>Ссылка на объект</code>
-   |Текст
+  |Владелец приложения
-   |<code>Текст</code>
+  |<code>{"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}</code>
+   |-
+   |<code>Индекс</code>
+  |Да
+  |<code>Число</code>
+   |Номер удаляемого приложения
+   |<code>11</code>
 |}
+* Пример вызова
+*; <pre>/GetData?Method=УдалитьПриложение&Владелец={"id": "e1cib/data/Справочник.яъКультуры?ref=96d5708bcda2156111eef01513b24eef"}&Индекс=11</pre>
+Пример ответа:
+<pre class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
+    true
+</pre>
 === СписокПриложений ===
@@ Строка 880: / Строка 937: @@
      ]
 </pre>
+=== СоздатьЗадачу (PostTask)  ===
+* '''Тип HTTP-запроса''': POST
+* '''Описание''': Создание документа «Задача».
+=== ПолучитьСписокЗадач (GetTaskList)  ===
+* '''Тип HTTP-запроса''': GET
+* '''Описание''': Список документов с отбором.
+=== ПолучитьСодержаниеЗадачи (GetTaskContent)  ===
+* '''Тип HTTP-запроса''': GET
+* '''Описание''': Получает все комментарии по документу в формате HTML.
+=== ПервыйКомментарий (GetFirstMessage)  ===
+* '''Тип HTTP-запроса''': GET
+* '''Описание''': Получает первый комментарий  по документу. Первый комментарий считается "Содержанием" документа.
+=== ПоследнийКомментарий (GetLastMessage)  ===
+* '''Тип HTTP-запроса''': GET
+* '''Описание''': Получает последний комментарий по документу.
+=== ИзменитьЭтапПроцесса (ChangeProcessStage)  ===
+* '''Тип HTTP-запроса''': GET
+* '''Описание''': Изменение этапа процесса документа.
+=== ДобавитьКомментарий (PostMessage) ===
+* '''Тип HTTP-запроса''': POST
+* '''Описание''': Добавление комментария к документу.
 = Кинт: Управление санаторием =
@@ Строка 5509: / Строка 5600: @@
 |3004|| Не удалось зарезервировать товары заказа покупателя.
 |}
-= Историй изменений, ссылки сюда =
-{{:Служебная:Whatlinkshere/API (Кинт)}}

API (Кинт) — различия между версиями

Версия 14:15, 21 ноября 2024

Содержание

Общая информация

Введение

Требования

Вызов методов

Предопределенные параметры запроса

Формат ответа

Коды ошибок

Запрос

Авторизация

Пагинация

Общие методы

GetCatalog (СписокЭлементов)

GetDBInfo (ДанныеИБ)

QRCode (КартинкаQR)

ОбъектПоНавигационнойСсылке

GetPrintForm (ПолучитьПечатнуюФорму)

GetReport (РезультатУФО)

GetDataSourceInfo (ОписаниеИсточникаДанных)

GetDataSource (ТаблицаИсточникаДанных)

ЕстьПраваАдминистратора

GetConstant

PostElement

ПолучитьИзмененияПоУзлу

КоличествоЭлементов

ЗаписатьПриложения

УдалитьПриложение

СписокПриложений

СоздатьЗадачу (PostTask)

ПолучитьСписокЗадач (GetTaskList)

ПолучитьСодержаниеЗадачи (GetTaskContent)

ПервыйКомментарий (GetFirstMessage)

ПоследнийКомментарий (GetLastMessage)

ИзменитьЭтапПроцесса (ChangeProcessStage)

ДобавитьКомментарий (PostMessage)

Кинт: Управление санаторием

Методы

Общие

GetNews

ИзменитьСтатусУчастникаМероприятия

PaymentStatusByDocument

КонтактыОрганизации

ПользовательПоНаименованию

ОфициальныеОрганы

РабочаяОрганизация

GetHtmlForms

Модуль «Гостиница»

GetAvailableDates

GetPrice

КартыГостя

ДанныеОбОсновнойКартеЛояльности

GetRoomQuota

GetAvailableRooms

GetAvailableCategories

RoomOccupancy

PostBooking

Дополнительные свойства

Пример кода на PHP

GetBookingInvoice

ОтметитьВыполнениеПотребностей

PostGuestCard

ChangeGuestParameters

Выбытие

Сокращение пребывания

Переселение / продление

Перерыв пребывания

Возобновление пребывания

Изменение пребывания

GetBookingList

CancelBooking

GetBookingStatus

CheckGuest

GetGuestData

Модуль «Медицина»

НазначенныеИсследования

СвойстваПациента

НазначенияМедикаментов

ПроцедурныеКабинеты