Версия 13:04, 15 марта 2023

Содержание

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

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

Введение

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`	Задаёт перечень реквизитов, которые должны быть переданы вместе с ссылками на элементы	`Ссылка,Контрагент,КонтактноеЛицо,Договор`	Не задано
`ДополнительныеСвойства`	`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

Запрос

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

Если параметр требует передачу любого ссылочного объекта - передаётся 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С: Предприятие, если соответствующие права у пользователя имеются.

Общие методы

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

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

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

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

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

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

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

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

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

{
    "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 (ПолучитьПечатнуюФорму)

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

Параметры:

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

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

/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": "[\n{\n\"Дело\": \"Разное\",\n\"Количество\": 7\n},\n{\n\"Дело\": \"КП\",\n\"Количество\": 2\n},\n{\n\"Дело\": \"К:БУ\",\n\"Количество\": 1\n}\n]"
}

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

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

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

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

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

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

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

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

Методы

Общие

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=ДанныеОбОсновнойКартеЛояльности&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}

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

{
"Ссылка": {
"Дата": "2023-03-06T09:51:55",
"Номер": "22/00000003              ",
"Идентификатор": "e1cib/data/Документ.яъКартаПокупателя?ref=94fda85e4511756911edb9bb423b5329"
},
"ПометкаУдаления": false,
"Номер": "22/00000003              ",
"Дата": "2023-03-06T09:51:55",
"Проведен": true,
"Контрагент": {
"ПометкаУдаления": 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"
},
"яъВидДокумента": {
"ПометкаУдаления": false,
"Предопределенный": true,
"ИмяПредопределенныхДанных": "_ДисконтнаяКарта",
"Наименование": "Карта лояльности",
"Код": "00081",
"Идентификатор": "e1cib/data/Справочник.яъВидыДокументов?ref=9a4a60a44c379a5b11e935b5799a1a4b"
},
"яъКомментарий": "",
"яъОрганизация": {
"ПометкаУдаления": 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="
}

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: поиск номеров, привязанных к определенной квоте;
ДополнительныеСвойства: вывод дополнительных свойств номера гостиницы;

Время заезда и выезда берется из настроек гостиницы.

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

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, Смена белья"
}
]
}

GetAvailableCategories

Работает аналогично методу GetAvailableRooms, сворачивает результат по категориям номеров гостиницы.

PostBooking

Отправка данных для создания новой заявки, в случае успеха метод возвращает номер, дату и идентификатор созданного документа.

Данные для создания заявки передаются в теле запроса в формате json.

Если запрос содержит параметр Test, в качестве результата метода вернется тело POST-запроса и текст в формате JSON, полученный после преобразования данных для создания заявки. Можно использовать для отладки.

Если запрос содержит параметр MakeReservation, будет выполнено предварительное бронирование заявки. Если в периоде пребывания по заявке свободных мест не найдено - заявка создана не будет.

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

Параметры пребывания могут быть переданы как в шапке, так и в строке массива гостей. Если параметр передан и в строке и в шапке - приоритетным считаем параметр строки. Если передан параметр Room - заявка забронирует места в переданном номере гостиницы.

Данные для создания гостей могут быть переданы двумя способами:

отдельным элементом строки массива гостей с именем "ФизЛицо", "Гость" или "Guest";
параметры для создания гостя находятся непосредственно в строке массива гостей.

Ключи структуры JSON можно передавать как кириллицей, так и латиницей. Рекомендуется использовать кириллицу.

Если в контексте создания заявки передан идентификатор заявки (навигационная ссылка или уникальный идентификатор (ID), дата и номер входящего документа (InboundDate, InboundNumber), будет выполнен поиск заявки и обновление реквизитов. Новая заявка создается в том случае, если по идентификатору ничего не найдено.

Структура поля «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": "Иванов Иван Иванович",
"BirthDate": "1980-11-11T00:00:00",
"Sex": "М",
"RegAddress": {},
"FactAddress": {}
},
"Guests": [
{
"Guest": {
"Name": "Иванов Сергей Иванович",
"BirthDate": "1995-01-11T00:00:00",
"Sex": "Мужской"
},
"DateFrom": "2018-10-01T00:00:00",
"Days": "10",
"RoomCategory": {
"ID": "e1cib/data/Справочник.НоменклатураПомещений?ref=88575404a66e4a8911e340740eaeea25"
}
}
],
"OrganizationOfStay": {
"ID": "e1cib/data/Справочник.Организации?ref=8e8150e54935bd5411e25bc6880bb616"
}
}

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

{
"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, который широко используется в разработке веб-сайтов. Он отправляет заявку на бронирование для двух гостей, и указывает одного из них в качестве плательщика (контрагента). <syntaxhighlight lang="php" class="toccolours mw-collapsible mw-collapsed" style="overflow: auto"> <?php

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

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

Параметры:

Пользователь: исполнитель потребностей.

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

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

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

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

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

{
"ФизЛицо": {
"Наименование": "Аверина Алина Игоревна",
"Пол": "Перечисление.яъПол.Женский",
"ДатаРождения": "2003-05-18T00:00:00",
"Адрес": "Россия, г.Ижевск Пушкинская 357а",
"МобильныйТелефон": "79508299587"
},
"Контрагент": {
"Идентификатор": "e1cib/data/Справочник.Контрагенты?ref=9a58f2e8cf1cc29211ea9a965dd1b350"
},
"ДатаЗаезда": "10.03.2023",
"КоличествоДней": 14,
"КатегорияНомера": "",
"НомерГостиницы": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0ee"},
"КатегорияПутёвки": "",
"ВариантЛечения": {"Идентификатор": "e1cib/data/Справочник.НаборыУслуг?ref=b20b6451060d98bd11e5bb4fe5828252"},
"ВариантПроживания": "ОсновноеМесто",
}

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

{
"Success": true,
"Result": {
"Дата": "2023-03-13T15:14:48",
"Номер": "23/00081       ",
"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc1904164be3e"
},
"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": []
}

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

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

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

Параметры:

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

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

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"}
],
"НаДату": "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=ОказанныеУслуги&Параметры={"НачалоПериода":"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": []
}

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

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=РасходныеПоПомещению&ДатаТребования=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": []
}

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

ЗаказГостяНаДату

Список блюд по рационам из заказа гостя.

Параметры:

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

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

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

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

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

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

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

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

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

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

/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"
},
"Контрагент": {
"Наименование": "Иванов Иван Иванович",
"ИНН": ""111111111111"",
"GUID": "3cc7dcfa-930d-11df-b942-001bfc345421"
},
"Товары": [
{
"Номенклатура": {
"Наименование": "Красная герань 30 мм",
"Артикул": "000112",
"GUID": "2b82b757-366b-11e9-982b-5404a66e4a81"
},
"Количество": 10,
"Цена": 150,
}
],
"ДополнительныеСвойства": [
{
"Свойство": "СуммаДоставки",
"Значение": 100
}
]
}

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

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

Коды ошибок

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

Историй изменений, ссылки сюда

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

Версия 13:04, 15 марта 2023

Содержание

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

Введение

Требования

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

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

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

Коды ошибок

Запрос

Авторизация

Общие методы

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

GetDBInfo (ДанныеИБ)

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

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

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

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

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

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

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

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

Методы

Общие

PaymentStatusByDocument

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

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

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

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

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

GetRoomQuota

GetAvailableRooms

GetAvailableCategories

PostBooking

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

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

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

PostGuestCard

ChangeGuestParameters

Выбытие

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

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

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

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

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

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

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

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

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

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

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

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

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

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

RoomCleaningStatus

ListRooms

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

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

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

ЗаказГостяНаДату

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

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

Коды ошибок

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

Методы

PostDocument

Коды ошибок

Историй изменений, ссылки сюда

Навигация

Поиск