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

Материал из КинтВики
Перейти к: навигация, поиск
(→‎Пагинация)
(→‎Пагинация)
Строка 173: Строка 173:
 
* [[#GetAvailableRooms|GetAvailableRooms]].
 
* [[#GetAvailableRooms|GetAvailableRooms]].
  
−
* Пример вызова:
+
; Пример вызова:
 
*; <pre>http://192.168.13.52/gd_kus/hs/KintAPI.hs/GetData?Method=GetCatalog&CatalogName=яъФизическиеЛица&PageNumber=6&CountOnPage=10 </pre>
 
*; <pre>http://192.168.13.52/gd_kus/hs/KintAPI.hs/GetData?Method=GetCatalog&CatalogName=яъФизическиеЛица&PageNumber=6&CountOnPage=10 </pre>
  

Версия 15:33, 26 августа 2024

Содержание

 [убрать] 

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

Введение

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

Требования

  1. База, к которой обращаются, должна быть опубликована на веб-сервере.
    1. При публикации базы, должна быть выполнена активация HTTP-сервиса KintAPI.
    2. Проверить правильность выполнения публикации можно путём обращения к методу GetDBInfo. Пример: https://demo.kint.ru/kus_demo/hs/KintAPI.hs/GetData?Method=GetDBInfo
  2. Разработчик должен иметь хотя бы минимальные представления о том, что такое 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

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

Пример вызова
  • http://192.168.13.52/gd_kus/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={"Пол": "Перечисление.яъПол.Мужской"}
Пример ответа
развернуть

GetDBInfo (ДанныеИБ)

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

Пример вызова
/GetDBInfo
Проверка работоспособности API
https://<адрес_сервера>/<имя_публикации>/hs/KintAPI.hs/GetDBInfo
Пример ответа
развернуть

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
Пример ответа
развернуть
Пример вызова для получения значения параметра
/GetData?Method=GetPrintForm&Объект={"GUID":%20"dc7970e4-e673-11e9-b48d-5404a66e4a89"}&ПечатнаяФорма={"GUID":%20"09c83fe6-f918-4388-a2ee-b0a3276941d4"}&ИмяПараметра=ФизЛицо
Пример ответа
развернуть

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

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

Параметры:

  • Отчет (GUID, обязательный) - навигационная ссылка на отчет.
  • ТипФайла - формат результата.
    • JSON, CSV позволяют получить таблицу данных отчета
    • XLSX, PDF, TXT, DOCX, MXL позволяют получить результат отчета в том же виде, в котором сохраняется табличный документ результата отчета в режиме «1С: Предприятие», данные закодированы в строку BASE64.
Пример вызова
/hs/KintAPI.hs/РезультатУФО?Отчет={"Идентификатор":%20"e1cib/data/Справочник.яъОтчеты?ref=9c415404a66e4a8911e4dcfb89878423"}&Формат=JSON
Пример ответа
развернуть

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

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

Параметры:

  • ИсточникДанных (GUID, обязательный) - навигационная ссылка на источник данных.
Пример вызова
/hs/KintAPI.hs/ОписаниеИсточникаДанных?ИсточникДанных=e1cib/data/Справочник.яъИсточникиДанных?ref=bca1d85ed320709611ed397243b5eb7d
Пример ответа
развернуть

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

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

Параметры:

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

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

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

GetConstant

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

Параметры:

  • ID/Идентификатор - название требуемой константы или настройки / код требуемого свойства.
Пример вызова
/hs/KintAPI.hs/GetConstant?ID=ПроцентПредоплатыБрони
Пример ответа
развернуть

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

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

КоличествоОбъектов

  • Тип HTTP-запроса: GET
  • Описание: Получение количества объектов
Параметры
Наименование Обязателен? Тип данных Описание Пример
ВидыОбъектов / ВидОбъекта Да Строка, Массив Тип объекта (По умолчанию справочник), вид объекта Организации,Документ.Путевка
Отбор / Filter Нет Структура Структура, указывающая, по каким реквизитам и их значениям необходимо делать отбор {"ИНН": "1835012280"}
Узел / CatalogType Нет Ссылка на узел плана обмена В результате окажется количество изменений по узлу {"Идентификатор": "e1cib/data/ПланОбмена.ОбменКУСБухгалтерия20?ref=9a4a60a44c379a5b11e91efe3f9ca517"}
  • Пример вызова 1: 
    /GetData?Method=КоличествоОбъектов&ВидОбъекта=яъФизическиеЛица

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

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

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

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

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

развернуть
  • Пример вызова 4 (Получение количества с общим отбором, дополнительным отбором по физ. лицам, отключенным отбором по коду для сотрудников): 
    /GetData?Method=КоличествоОбъектов&ВидыОбъектов=[{ "ВидОбъекта":"яъФизическиеЛица", "Отбор": {"Наименование": "Макадзару"} },{ "ВидОбъекта":"Контрагенты" },{ "ВидОбъекта":"Сотрудники", "Отбор": {"Код": ""} }]&Отбор={"Код": "000000001"}

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

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

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

развернуть

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

Методы

Общие

GetNews

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

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

  • Параметры: структура параметров, которые используются в шаблонах страницы.
    • Развернуть: если значение «Истина», то новости будут развернуты при загрузке страницы.
    • ОграничитьШирину: если значение «Истина», то новости будут отображаться посередине экрана, образуя «Ленту» новостей.
  • ВКонтейнер: если значение «Истина», то к макетам будет подключена стандартная библиотека.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetNews&raw&Параметры={"Развернуть":true,"ОграничитьШирину":true}
Пример ответа
развернуть

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

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

Параметры:

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

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

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

PaymentStatusByDocument

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

Параметры:

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

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

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

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

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

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

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

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

Параметры:

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

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

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

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

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

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

Параметры:

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

GetHtmlForms

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

Параметры:

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

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

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

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

GetAvailableDates

Доступные интервалы заезда за период.

Параметры:

  • ArrivalFrom/ЗаездС: начало периода заезда.
  • ArrivalTo/ЗаездПо: конец периода заезда.
  • Days/КоличествоДней: желаемое количество дней проживания.

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

  • RoomCategory/КатегорияНомера: желаемая категория номера.
  • Block/Корпус: желаемый корпус.
  • QuotaID/Квота: требуемая квота (учитываются только квоты по номерам).
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetAvailableDates&ArrivalFrom=30.08.2023&ArrivalTo=05.09.2023&Days=4&RoomCategory={"Идентификатор":%20"e1cib/data/Справочник.НоменклатураПомещений?ref=ac2360a44c379a5b11e565e573e3b690"}&Block={"Идентификатор":%20"e1cib/data/Справочник.Здания?ref=bd4860a44c379a5b11e3a8f481c4453e"}&QuotaID={"Идентификатор":%20"e1cib/data/Справочник.Квоты?ref=9a6860a44c379a5b11eb9d1bc1a84df1"}
Пример ответа
развернуть

GetPrice

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

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

  • DateFrom/НачалоПериода/ДатаЗаезда: начало периода проживания. Значение по умолчанию - начало текущего дня.
  • DateTo/КонецПериода/ДатаВыезда: конец периода проживания. Значение по умолчанию - конец текущего дня.
  • ВариантРасчетаЦен: вариант расчета цены. Значение по умолчанию будет получено из настройки.
  • Контекст: структура с различными дополнительными параметрами (Организация, Прайс, Время суток заезда, Время суток выезда, Заезд вечером, Выезд вечером).
  • ВидЦен: Идентификатор или ссылка на вид цены. Значение по умолчанию - цена брони.
  • Details/Расшифровка: развернуть цену по дням.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetPrice&Контекст={"DateFrom": "15.02.2023", "DateTo":"18.02.2023"}
Пример ответа
развернуть

КартыГостя

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

Параметры:

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

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

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

Параметры:

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

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

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

GetRoomQuota

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

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

  • RoomCategory: если требуется получить данные по определенной категории(ям) номеров, пример &RoomCategory={"ID":"e1cib/data/Справочник.НоменклатураПомещений?ref=88575404a66e4a8911e340740eaeea25"};
  • Seats: будет учитываться количество свободных мест при определении доступной квоты, пример вызова: &Seats=true
  • TypeOfQuota: вид документа онлайн-квоты, по которым требуется получить квоту. Доступные значения: Travelline, Wubook, KintAPI, пример вызова: &TypeOfQuota=KintAPI
  • OrganizationOfStay: если требуется получить квоту, привязанную к определенной организации (актуально для баз в которых ведется учет по нескольким организациям), пример вызова: &OrganizationOfStay={"ID":"e1cib/data/Справочник.Организации?ref=8e8150e54935bd5411e25bc6880bb616"}
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetRoomQuota&DateFrom=2018-08-01T00:00:00&DateTo=2018-08-31T00:00:00
Пример ответа
развернуть

GetAvailableRooms

Получение данных о доступных (свободных) номерах за период, обязательно передавать период, за который требуется получить данные. Возвращает массив структур с описанием номеров гостиницы. Все доступные поля отображены в разделе "Пример ответа". Обязательные параметры запроса DateFrom - начало периода проживания DateTo - конец периода проживания

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

  • Qty - количество мест в одном номере. Будут подобраны все номера где есть требуемое количество свободных мест. Если не передан - будут подобраны все доступные номера.
  • Vacant: если передано значение true - будут подобраны только полностью свободные номера;
  • RoomCategory: если требуется получить данные по определенной категории(ям) номеров;
  • Room: проверка доступности определенного номера гостиницы;
  • OrganizationOfStay: если требуется получить номера, привязанные к определенной организации (актуально для баз в которых ведется учет по нескольким организациям)
  • QuotaID: поиск номеров, привязанных к определенной квоте; Например &QuotaID={"ID":"e1cib/data/Справочник.Квоты?ref=813800155d1e281211ec0952ca92c338"}
  • ДополнительныеСвойства: вывод дополнительных свойств номера гостиницы;

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

Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=GetAvailableRooms&DateFrom=2019-09-24T00:00:00&DateTo=2019-09-29T00:00:00&Vacant=true&Qty=2
Пример ответа
развернуть

GetAvailableCategories

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

PostBooking

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

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

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

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

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

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

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

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

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

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

Структура поля «Guest» может содержать ключ ВидУдостоверения, в этом случае будут заполнены данные об удостоверении личности гостя. В значении этого поля должно быть значение «Паспорт» или произвольное наименование удостоверения, которое есть в базе данных (справочник Справочник «Виды удостоверений»).

Также структура поля «Guest» может содержать ключ Телефон, который необходимо вводить в соответствии с маской страны физлица или контрагента. Телефон используется как ключ уникальности для физлиц (Параметр «ЭтоФизЛицо» = Истина или явно передана категория «Физическое лицо»).

Поля для заполнения данных удостоверения личности: ДокументСерия, ДокументНомер, ДокументДатаВыдачи, ДокументКемВыдан, ДокументКодПодразделения, ДатаРегистрацииПоМестуЖительства.

Передача поля Адрес регистрации: поиск адреса выполняется по ключевому полю ИдентификаторФИАС или FIAS_ID. Если идентификатор не передан, выполняется поиск по наименованию. В запросе это одно из полей: Raw, Наименование, Name.

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

Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/PostData?Method=PostBooking
Тело запроса (параметры в шапке)
развернуть
Тело запроса (параметры в строке)
развернуть
Пример ответа
развернуть

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

Пример заполнения полей справки
развернуть
Дополнительные свойства

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

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

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

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

развернуть
Пример кода на PHP

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

развернуть

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

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

Параметры:

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

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

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

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

{
"Наряд": {
"ДатаНачала": "2023-03-10T00:00:00",
"ДатаОкончания": "2023-03-12T00:00:00"
},
"Потребности": [
{
"Услуга": {"Идентификатор": "e1c://filev/C/Users/na/Documents/InfoBase#e1cib/data/Справочник.Услуги?ref=b33060a44c379a5b11e7af51a0e04cd2"},
"Дата": "2023-03-10T00:00:00",
"Кабинет": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c115"},
"ДокументНазначения": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1fdca75068"}
}
]
}
Пример ответа
развернуть

PostGuestCard

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

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

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

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

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

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

  • В качестве договора карты гостя будет выступать основной договор контрагента. Если договора нет, то он будет создан и назначен основным.
  • Между физическим лицом и контрагентом всегда будет установлена связь, вне зависимости от того, в каком виде они были переданы.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=PostGuestCard

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

развернуть
Пример ответа
развернуть

ChangeGuestParameters

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

Параметры:

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

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

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

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

  • ДатаОперации: дата сокращения пребывания. Значение по умолчанию - текущая дата (или дата заезда, если операция выполняется будущим числом).
  • ВремяОперации: время сокращения пребывания. Значение по умолчанию - время выезда гостя.
  • СВыбытием: выполнить ли выбытие после сокращения пребывания.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=СокращениеПребывания&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}

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

{
"ДатаОперации": "2023-03-11T00:00:00",
"ВремяОперации": "0001-01-01T19:00:00",
"СВыбытием": "Истина"
}
Пример ответа
развернуть
Переселение / продление

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

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

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

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

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

{
"КоличествоДней": 4,
"ДатаОперации": "2023-03-11T00:00:00",
"НовоеВремяВыезда": "0001-01-01T12:00:00",
"Причина": "Смерть родственника",
"НомерГостиницы": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c12a"}
}
Пример ответа
развернуть
Перерыв пребывания

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

  • ДатаОперации: дата начала перерыва пребывания. Значение по умолчанию - дата заезда гостя.
  • ВремяОперации: время начала перерыва пребывания. Значение по умолчанию - время выезда гостя.
  • ДатаОкончанияОперации: дата окончания перерыва пребывания.
  • ВремяОкончанияОперации: время окончания перерыва пребывания.
  • СохранитьНомер: сохранить номер за гостем. Значение по умолчанию - ложь. Принимает ложь, если указана дата окончания операции.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=ПерерывПребывания&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}

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

{
"ДатаОперации": "2023-03-11T00:00:00",
"ВремяОперации": "0001-01-01T12:00:00",
"СохранитьНомер": "Истина"
}
Пример ответа
развернуть
Возобновление пребывания

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

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

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

{
"ДатаОперации": "2023-03-11T00:00:00",
"ВремяОперации": "0001-01-01T12:00:00",
}
Пример ответа
развернуть
Изменение пребывания

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

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

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

  • ДатаОперации: дата изменения параметров пребывания.
  • ВремяОперации: время изменения параметров пребывания.
  • НомерГостиницы: новый номер гостиницы гостя. Требуется только для вида «Заявка на изменение проживания». Параметр обязателен, если до операции вариант проживания гостя был «Без проживания».
  • ПомещениеПитания: новое помещение питания гостя. Требуется только для вида «Заявка на изменение питания».
  • ОборудованиеПитания: новое оборудование питания гостя. Требуется только для вида «Заявка на изменение питания».
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ChangeGuestParameters&Операция=ИзменениеПребывания&КартаГостя={"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edbf1bf86f3635"}

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

{
"ВидДокумента": "ЗаявкаНаИзменениеПитания",
"ВариантПитания": "ОбщийСтол",
"ПомещениеПитания": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e586d5cb31c0f0"},
"ОборудованиеПитания": {"Идентификатор": "e1cib/data/Справочник.Номенклатура?ref=b87a60a44c379a5b11e84226f79ecc90"},
"ДатаОперации": "2023-03-18T00:00:00"
}
Пример ответа
развернуть

GetBookingList

Список заявок заявителя.

Так же может возвращать все заявки по периоду, начиная с 21.07.01. Для этого передаётся параметры "НачалоПериода", "КонецПериода". Можно как один, так и оба сразу.

Пример вызова
/GetData?Method=GetBookingList&Client={"ID":"e1cib/data/Справочник.Контрагенты?ref=aab56c626dc53d6911e8a44b45d09480"}
Пример ответа
Аналогично методу GetBookingStatus.

CancelBooking

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

В зависимости от текущего состояния заявки выполняются следующие действия:

  • Принята (документ не проведен): устанавливается пометка на удаление документа, в реквизит "Комментарий" документа записывается причина отмены.
  • В работе (документ проведен): создается общий отказ по всем строкам заявки с указанием причины.
  • Завершена (создан документ "Путевка"): для каждой путевки, созданной на основании заявки выполняется операция "Снятие брони" с указанием причины.

Если переданная заявка уже отменена, вернется ошибка обработки с соответствующим кодом и описанием.

Пример вызова
/PostData?Method=CancelBooking&DenyReason={"GUID": "21b146ad-cad2-11e8-9a46-60a44c379a5b"}
Тело запроса
[
{
"Booking": {
"GUID": "78fd6678-86d4-11e5-a33f-60a44c379a5b"
},
"DenyReason": {
"GUID": "49fde0fc-bb04-11e8-b458-5404a66e4a89"
}
},
{
"Booking": {
"GUID": "49fde0fc-bb04-11e8-b458-5404a66e4a89"
}
}
]
Пример ответа
развернуть

GetBookingStatus

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

Дополнительные параметры:

  • AdditionalProperties: в результат будут добавлены значения дополнительных свойств заявки, заданных для нее в базе. Список свойств передается через запятую без пробелов. В 1С это поле КОД доп. свойства.
  • PrintForm: вывод файла печатной формы в формате PDF. Необходимо передавать ИД печатной формы в базе КУС: PrintForm={"GUID":"c357203b-c09c-11e8-b45b-5404a66e4a89"}

Возможные статусы заявок:

  • Принята: Документ не проведен. Её движения не активны.
  • Отменена: Документ не проведен и помечен на удаление.
  • В работе: Документ проведен и есть не закрытые строки.
  • Отказано: Все строки документа закрыты отказам по заявке.
  • Завершена: Все строки документа закрыты и есть хотя бы одна созданная по ним путевка.
Пример вызова
/GetData?Method=GetBookingStatus&Booking=[{"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=b4535404a66e4a8911e89ae406700121"}, {"GUID": "78fd6678-86d4-11e5-a33f-60a44c379a5b"}]
Пример ответа
развернуть

CheckGuest

Выполняет поиск карты гостя по переданным реквизитам и проверяет ее актуальность.

Пример структуры параметров
{
   "ДатаЗаезда":"2020-07-15T00:00:00",
   "Физлицо_ДатаРождения":"1949-01-23T00:00:00",
   "НаДату":"2020-07-28T00:00:00"
}

Параметры отбора карты гостя передаются в структуре с имененем "Отбор" или "Filter". Вложенные реквизиты должны быть переданы с разделителем "_", например: дата рождения физлица: "Физлицо_ДатаРождения". Служебные параметры отбора:

  • НаДату: на какую дату проверять регистрацию гостя. Если не передан, то проверяется на текущую дату.
  • УчитыватьВремя (булево): учитывать время суток заезда и выезда гостя. По умолчанию время не учитывается.

Параметр ВернутьКартуГостя (булево) позволяет вернуть в ответе идентификатор карты гостя, если она найдена и актуальна. По умолчанию возвращается только признак актуальности. Реквизиты карты гостя могут быть получены с помощью предопределенного параметра Fields. Признак успешного поиска карты гостя возвращается в поле КартаГостяНайдена.

Пример вызова
/GetData?Method=CheckGuest&Отбор={"ДатаЗаезда":"2020-07-15T00:00:00","Физлицо_ДатаРождения":"1949-01-23T00:00:00","НаДату":"2020-07-16T00:00:00"}&ВернутьКартуГостя=true&Fields=ДатаЗаезда,ДатаВыезда
Пример ответа
{
"Success": true,
"Result": {
"Date": "2020-07-14T17:13:24",
"Number": "t0123/00048",
"ID": "e1cib/data/Документ.КартаГостя?ref=977af46d0477991a11ee3cfe22c317ca"
"ДатаЗаезда": "2020-07-15T00:00:00",
"ДатаВыезда": "2020-07-25T00:00:00",
"КартаГостяНайдена": true
}
}
Пример ответа с параметром &ВернутьКартуГостя=false
{
"Success": true,
"Result": true
}

GetGuestData

Возвращает информацию о физлице на основании ссылки на физлицо. Параметры:

  • ФизЛицо: структура с ссылкой на физическое лицо, данные о котором необходимо извлечь.
Пример вызова
/GetGuestData?Физлицо={"Идентификатор": "e1cib/data/Справочник.яъФизическиеЛица?ref=bc98d85ed320709611ed0990f9042959"}
Пример ответа
развернуть

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

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

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

Параметры:

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

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

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

Параметры:

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

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

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

Параметры:

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

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

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

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

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

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

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

  • Параметры: параметры отбора назначений. Можно передать пустую структуру для получения всех назначений. Доступны параметры:
    • КартаГостя: карта гостя пациента.
    • ФизЛицо: физическое лицо пациента.
    • ДокументНазначения: документ назначения.
    • фОплата: получить таблицу с оплатой счетов.
    • Кабинет: кабинеты, по которым необходимо получить назначения.
    • НачалоПериода: начало периода сеансов.
    • КонецПериода: конец периода сеансов.
    • КатегорияУслуги: получить только услуги переданной категории.
    • НаДату: дата документов назначения сеансов.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=НазначенияИРезультаты

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

{
"Параметры": {
"КартаГостя": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"},
"фОплата": false,
"Кабинет": [
{"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6735a8e750"}
],
"КатегорияУслуги": {"Идентификатор": "e1cib/data/Справочник.яъКатегории?ref=9777f46d0477991a11ede40656633b10"}
"НаДату": "2023-03-16T00:00:00",
"НачалоПериода": "2023-03-03T00:00:00",
"КонецПериода": "2023-03-14T00:00:00"
}	
}
Пример ответа
развернуть

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

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

Параметры:

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

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

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

Параметры:

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

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

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

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

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

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

  • Исполнитель: исполнитель услуг. Значение по умолчанию - текущий пользователь.
  • QRКод: признак отметки услуги по QR-коду.
  • фПлатная: признак платности услуги.
  • фСрочная: признак срочной услуги.
  • ПараметрыНазначения: параметры назначения услуги.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ИзменитьСостояниеСеанса

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

{
"фОтмена": false,
"Дата": "2023-03-18T00:00:00",
"Услуга": {"Идентификатор": "e1cib/data/Справочник.Услуги?ref=a33f60a44c379a5b11e58a0551163e70"},
"Пациент": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc22a22d2dea3"},
"Исполнитель": {"Идентификатор": "e1cib/data/Справочник.Сотрудники?ref=b20b6451060d98bd11e5a7ef357c1a80"},
"ДокументНазначения": {"Идентификатор": "e1cib/data/Документ.НазначениеУслуг?ref=94fea85e4511756911edc25f873125fc"},
"Кабинет": {"Идентификатор": "e1cib/data/Справочник.Помещения?ref=a33f60a44c379a5b11e58c6771c76040"},
"КодСтроки": 4,
"QRКод": true,
"фСрочная": true
}
Пример ответа
развернуть

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

GetPaymentQRCode

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

Параметры:

  • ТипКода: тип необходимого QR-кода. Поддерживаются "СБП" и "Обычный".
  • СчетНаОплату: структура, описывающая счёт на оплату, или содержащая ссылку на уже существующий.
Пример вызова
/GetPaymentQRCode?ТипКода=["СБП", "Обычный"]&СчетНаОплату={"Идентификатор": "e1cib/data/Документ.СчетНаОплатуПокупателю?ref=b4bd5404a66e4a8911ebc434d07efc77"}
Пример ответа
развернуть

GetAcceptances

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

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

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

AcceptPayment

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

Параметры запроса:

  • Основание: документ «Заявка», по которому необходимо выставить счет.
  • Контрагент: контрагент, которому необходимо выставить счет.
  • Договор: договор, контрагента, по которому необходимо выставить счет.
  • ЗаполнитьПоДокументу: признак заполнения счета по документу. Если параметр не передан или передан в значении «Ложь», то документ будет заполнен по невыставленным услугам.
  • мсУслуги: таблица с услугами. Основными параметрами являются: номенклатура, количество, цена, сумма. Возможна передача пустой цены, в таком случае цена будет получена по настройке ценообразования. Если параметр передан, то параметр «ЗаполнитьПоДокументу» игнорируется.
  • ПроцентПредоплаты: процент предоплаты, на который выставляется счет. Если параметр передан, то счет будет выставлен на соответствующий процент количества услуг.
  • ОтправитьНаEmail: печатная форма, которую необходимо отправить контрагенту на Email, установленный в его контактных данных. Если параметр передан с пустым значением, то будет отправлена стандартная печатная форма счета на оплату.
  • СбербанкИдентификатор: идентификатор платежа в сбербанке. Начиная с релиза 24.01 не используется.
  • ЭквайрингИДСчета: идентификатор платежа У Оператора Эквайринга. Используется начиная с релиза 24.01.
  • Контекст: структура со значением остальных реквизитов счета.
Пример вызова
/AcceptPayment
Счет на предоплату 50% стоимости, заполнение по документу
{
"Контрагент": {"ID": "e1cib/data/Справочник.Контрагенты?ref=9510a85e4511756911ee52ea8a5111a5"},
"Договор": {"ID": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=9510a85e4511756911ee52ea8a5111a6"},
"Основание": {"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=9511a85e4511756911ee698a1ac22021"},
"ЗаполнитьПоДокументу": true,
"ПроцентПредоплаты": 50,
"ОтправитьНаEmail": null,
"Контекст": {"СрокОплаты": "2023-10-13T15:10:45"}
}
Пример ответа
развернуть
Счет на оплату на 10 единиц номенклатуры.
{
"Контрагент": {"ID": "e1cib/data/Справочник.Контрагенты?ref=9510a85e4511756911ee52ea8a5111a5"},
"Договор": {"ID": "e1cib/data/Справочник.ДоговорыКонтрагентов?ref=9510a85e4511756911ee52ea8a5111a6"},
"Основание": {"ID": "e1cib/data/Документ.ЗаявкаПокупателя?ref=9511a85e4511756911ee698a1ac22021"},
"мсУслуги": [
{
"Номенклатура": {"ID": "e1cib/data/Справочник.Номенклатура?ref=9a4e60a44c379a5b11e9b3808b34f6b5"},
"Количество": 10
}
]
}
Пример ответа
развернуть

RegisterPayment

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

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

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

GetInvoices

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

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

Пример вызова
/GetData?Method=GetInvoices&Контрагент={"ID":%20"e1cib/data/Справочник.Контрагенты?ref=9a6c5404a66e4a8911e5bb8e2aa076f5"}&Договор={"ID":%20"e1cib/data/Справочник.ДоговорыКонтрагентов?ref=bfdd7085c2c0660b11ebd27de6bcea8a"}&Основание={"ID":"e1cib/data/Документ.ЗаявкаПокупателя?ref=97495404a66e4a8111ec2a58b844326f"}&Fields=СуммаДокумента
Пример ответа
развернуть

RoomCleaningStatus

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

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

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

ListRooms

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

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

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

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

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

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

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

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

Параметры:

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

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

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

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

  • ДокументСерия: серия документа.
  • ДокументНомер: номер документа.
  • ДокументДатаВыдачи: дата выдачи документа.
  • ДокументКемВыдан: кем выдан документ.
  • ДокументКодПодразделения: код подразделения документа.
  • ДатаРегистрацииПоМестуЖительства: дата регистрации по месту жительства.
  • ДействителенДо: дата окончания действия документа.
  • ТипВизы: код типа визы МВД.
  • КратностьВизы: код кратности визы МВД.
  • ЦельВъезда: код цели въезда по визе МВД.
  • КодПунктаПересечения: код пункта пересечения границы.
  • ПунктПересеченияГраницы: пункт пересечения границы.
  • ФилиалФСС: номер филиала ФСС.
  • НомерСтрахователя: регистрационный номер страхователя.
  • ОкончаниеРегистрации: дата окончания регистрации.
  • ТипПолисаОМС: тип полиса ОМС.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ЗаписатьУдостоверениеФизлица&ФизЛицо={"Идентификатор":"e1cib/data/Справочник.яъФизическиеЛица?ref=b20b6451060d98bd11e59cb642414f2b"}
Тело запроса
развернуть
Пример ответа
развернуть

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

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

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

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

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

PostMenu

Записывает выбор гостя по меню-раскладке на выбранный день.

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

  • Описание шахматки-меню для гостя.
Пример вызова

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

{
    "ИдентификаторКонтекста": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "СодержимоеЗаказа": [
        {
            "Потребность": {"Идентификатор": "e1cib/data/Справочник.дтБлюда?ref=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"},
            "Количество": 1
        }
    ]
}

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

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

Параметры:

  • Параметры: Структура, содержащая параметры:
    • НаДату: дата заказа.
    • КартаГостя: карта гостя, по которой необходимо получить заказ.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ЗаказГостяНаДату&Параметры={"КартаГостя": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fda85e4511756911edb98261ada96f"}, "НаДату": "2023-03-04T00:00:00"}
Пример ответа
развернуть

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

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

Параметры:

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

тзУФО_Меню

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

Параметры:

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

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

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

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

  • Заявитель: карта гостя заказчик блюд.
  • НаДату: срок исполнения заказа.
  • мсБлюда: массив структур с блюдами для заказа, содержащих:
    • Услуга: услуга (рацион).
    • Потребность: блюдо для заказа.
    • Количество: количество блюда для заказа.
Пример вызова
http://127.0.0.1/имя_публикации/hs/KintAPI.hs/GetData?Method=ЗаказатьБлюда

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

{
"Заявитель": {"Идентификатор": "e1cib/data/Документ.КартаГостя?ref=94fea85e4511756911edc2fdd62e6acd"},
"НаДату": "2023-03-22T00:00:00",
"мсБлюда": [
{
"Услуга": {"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d0"},
"Потребность": {"Идентификатор" : "e1cib/data/Справочник.Номенклатура?ref=91b56451060d98bd11e5ec381c250734"},
"Количество": 1 
},
{
"Услуга": {"Идентификатор": "e1cib/data/Справочник.Услуги?ref=bd4860a44c379a5b11e3ab44727047d2"},
"Потребность": {"Идентификатор" : "e1cib/data/Справочник.дтБлюда?ref=91b56451060d98bd11e5ec37ee03fce4"},
"Количество": 2
}
]
}
Пример ответа
развернуть

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

Внутренний Внешний
Наименование Name
Код Code
Идентификатор ID
Контрагент Client
ОписаниеОшибки Error
НомерГостиницы Room
КатегорияНомера RoomCategory
Дата Date
Номер Number
НачалоПериода DateFrom
КонецПериода DateTo
Количество Qty
ОрганизацияПребывания Sanatorium
Состояние Status
ПредварительноЗабронировано Booked
Подтверждено Processed
Отказано Denied
ОсталосьОбработать ToProcess
ПричинаОтказа DenyReason
Заявка Booking
Файл File
КоличествоДней Days
ОрганизацияПребывания OrganizationOfStay
Семья Family
Гости Guests
Пол Sex
СтепеньРодства Relation
АдресРегистрации RegAddress
ДатаРождения BirthDate
НомерСНИЛС SNILS
Категория Category
МестоРождения Birthplace
Гражданство Citizenship
стрМестоРаботы PlaceOfWork
стрДолжность Position
ИдентификаторФИАС FIAS_ID
Дом House
Корпус Block
Квартира Flat
ПочтовыйИндекс ZipCode
стрДопСвойства AdditionalProperties
ПечатнаяФорма PrintForm
Квота QuotaID
Продавец Agent
Прайс Price
КатегорияПутевки VoucherCategory
Справка MedicalCertificate
ЛечебноеУчреждение MedicalInstitution
ДиагнозНаправившегоУчреждения MKB10
ДатаВходящегоДокумента InboundDate
НомерВходящегоДокумента InboundNumber

Коды ошибок

Код ошибки (ErrorCode) Описание
1020 Ошибка создания документа «Заявка» методом PostBooking
1021 Ошибка обработки файлов, приложенных к заявке или справке.
1025 Не найдена заявка по ссылке при запросе статуса методом GetBookingStatus.
1030 Не найдена заявка по ссылке при отказе методом CancelBooking.
1031 Ошибка установки пометки заявки на удаление методом CancelBooking.
1032 Ошибка выполнения отказа по заявке методом CancelBooking.
1033 Ошибка снятия брони по подтвержденной заявке методом CancelBooking.

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

Методы

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 Не удалось зарезервировать товары заказа покупателя.

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

Источник — «http://wiki.kint.ru/index.php?title=API_(Кинт)&oldid=81269»