T: відмінності між версіями
Перейти до навігації
Перейти до пошуку
Немає опису редагування |
Немає опису редагування |
||
Рядок 1: | Рядок 1: | ||
=Опис функцій спілкування= | =Опис функцій спілкування= | ||
==GetGuestsModified== | ==GetGuestsModified== | ||
Функція GetGuestsModified повертає інформацію про гостей готелю, що були змінені після вказаної дати, або помилку. | *Функція GetGuestsModified повертає інформацію про гостей готелю, що були змінені після вказаної дати, або помилку. | ||
'''Вхідні параметри:''' | '''Вхідні параметри:''' | ||
#Credentials – облікові дані користувача: | #Credentials – облікові дані користувача: | ||
#UserName – string, ім’я користувача; | #UserName – string, ім’я користувача; | ||
#Password – string, пароль користувача. | #Password – string, пароль користувача. | ||
#Hotels – масив ідентифікаторів готелів (якщо 0 – усі доступні). | #Hotels – масив ідентифікаторів готелів (якщо 0 – усі доступні). | ||
#ModifiedDateFrom – string, "yyyy-MM-dd HH:mm:ss", дата та час, з якого враховувати зміни (необов’язково). | #ModifiedDateFrom – string, "yyyy-MM-dd HH:mm:ss", дата та час, з якого враховувати зміни (необов’язково). | ||
#GuestsID – масив string, фільтр за ідентифікаторами гостей (необов’язково). | #GuestsID – масив string, фільтр за ідентифікаторами гостей (необов’язково). | ||
#GuestStatus – масив int, статуси гостей:0 – заброньовані;2 – проживають;3 – виїхали;1 – анульовано;2 – незаїзд. | #GuestStatus – масив int, статуси гостей:0 – заброньовані;2 – проживають;3 – виїхали;1 – анульовано;2 – незаїзд. | ||
#isNeedCostInfo – string (0/1), чи виводити інформацію про вартість (0 – ні, за замовчуванням). | #isNeedCostInfo – string (0/1), чи виводити інформацію про вартість (0 – ні, за замовчуванням). | ||
#ServiceClasses – масив string, коди класів послуг, що враховуються у вартість.<br> | #ServiceClasses – масив string, коди класів послуг, що враховуються у вартість.<br> | ||
#ExcludeServiceSubclasses – масив string, коди підкласів послуг, що не враховуються у вартість. | #ExcludeServiceSubclasses – масив string, коди підкласів послуг, що не враховуються у вартість. | ||
#isNeedClientInfo – string (0/1), чи виводити анкетні дані (0 – ні, за замовчуванням). | #isNeedClientInfo – string (0/1), чи виводити анкетні дані (0 – ні, за замовчуванням). | ||
#isNeedClientPhoto – string (0/1), чи вивантажувати фото клієнта. | #isNeedClientPhoto – string (0/1), чи вивантажувати фото клієнта. | ||
#isNeedDocumentsInfo – string (0/1), чи виводити дані документів. | #isNeedDocumentsInfo – string (0/1), чи виводити дані документів. | ||
#GuestName – string, ПІБ гостя (необов’язково). | #GuestName – string, ПІБ гостя (необов’язково). | ||
#PhoneNumber – string, телефон гостя (необов’язково). | #PhoneNumber – string, телефон гостя (необов’язково). | ||
#Mail – string, електронна пошта гостя (необов’язково). | #Mail – string, електронна пошта гостя (необов’язково). | ||
#ClientID – int, ідентифікатор анкети гостя (необов’язково). | #ClientID – int, ідентифікатор анкети гостя (необов’язково). | ||
#Preferences – масив об'єктів з полями: | #Preferences – масив об'єктів з полями: | ||
*Code – string, код переваги; | *Code – string, код переваги; | ||
*Value – string, значення переваги. | *Value – string, значення переваги. | ||
#ComplexSearch – об'єкт для комплексного пошуку: | #ComplexSearch – об'єкт для комплексного пошуку: | ||
Рядок 28: | Рядок 28: | ||
'''Значення, що повертається:''' | '''Значення, що повертається:''' | ||
*Повертається JSON-структура з такими полями: | |||
#VersionInfo – string, версія API. | #VersionInfo – string, версія API. | ||
#RequestTime – string, час формування відповіді на сервері (UTC, мілісекунди). | #RequestTime – string, час формування відповіді на сервері (UTC, мілісекунди). | ||
Рядок 44: | Рядок 44: | ||
*RoomNumber – string, номер кімнати; | *RoomNumber – string, номер кімнати; | ||
*Floor – string, поверх; | *Floor – string, поверх; | ||
#RoomType – об'єкт: | #RoomType – об'єкт: | ||
*RoomTypeName – string, назва типу кімнати; | *RoomTypeName – string, назва типу кімнати; | ||
*RoomTypeShortName | *RoomTypeShortName |
Версія за 06:23, 21 травня 2025
Опис функцій спілкування
GetGuestsModified
- Функція GetGuestsModified повертає інформацію про гостей готелю, що були змінені після вказаної дати, або помилку.
Вхідні параметри:
- Credentials – облікові дані користувача:
- UserName – string, ім’я користувача;
- Password – string, пароль користувача.
- Hotels – масив ідентифікаторів готелів (якщо 0 – усі доступні).
- ModifiedDateFrom – string, "yyyy-MM-dd HH:mm:ss", дата та час, з якого враховувати зміни (необов’язково).
- GuestsID – масив string, фільтр за ідентифікаторами гостей (необов’язково).
- GuestStatus – масив int, статуси гостей:0 – заброньовані;2 – проживають;3 – виїхали;1 – анульовано;2 – незаїзд.
- isNeedCostInfo – string (0/1), чи виводити інформацію про вартість (0 – ні, за замовчуванням).
- ServiceClasses – масив string, коди класів послуг, що враховуються у вартість.
- ExcludeServiceSubclasses – масив string, коди підкласів послуг, що не враховуються у вартість.
- isNeedClientInfo – string (0/1), чи виводити анкетні дані (0 – ні, за замовчуванням).
- isNeedClientPhoto – string (0/1), чи вивантажувати фото клієнта.
- isNeedDocumentsInfo – string (0/1), чи виводити дані документів.
- GuestName – string, ПІБ гостя (необов’язково).
- PhoneNumber – string, телефон гостя (необов’язково).
- Mail – string, електронна пошта гостя (необов’язково).
- ClientID – int, ідентифікатор анкети гостя (необов’язково).
- Preferences – масив об'єктів з полями:
- Code – string, код переваги;
- Value – string, значення переваги.
- ComplexSearch – об'єкт для комплексного пошуку:
- SearchString – string, рядок для пошуку;
- SearchObjects – масив string, поля для пошуку: "GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard".
Значення, що повертається:
- Повертається JSON-структура з такими полями:
- VersionInfo – string, версія API.
- RequestTime – string, час формування відповіді на сервері (UTC, мілісекунди).
- ErrorCode – string, код помилки:
- 0 – помилок немає.
- ErrorText – string, текст помилки, якщо вона є.
- Hotels – масив об'єктів з інформацією про готелі:
- HotelInformation – об'єкт:
*HotelID – int, ідентифікатор готелю; *HotelName – string, назва готелю;
- HotelShortName – string, коротка назва готелю.
- Guests – масив гостей, які відповідають фільтрам:
- Room – об'єкт:
- RoomId – int, ідентифікатор номера;
- RoomNumber – string, номер кімнати;
- Floor – string, поверх;
- RoomType – об'єкт:
- RoomTypeName – string, назва типу кімнати;
- RoomTypeShortName