T: відмінності між версіями
Перейти до навігації
Перейти до пошуку
Немає опису редагування |
Немає опису редагування |
||
Рядок 22: | Рядок 22: | ||
#Preferences – масив об'єктів з полями:<br> | #Preferences – масив об'єктів з полями:<br> | ||
*Code – string, код переваги;<br> | *Code – string, код переваги;<br> | ||
*Value – string, значення переваги. | *Value – string, значення переваги. | ||
#ComplexSearch – об'єкт для комплексного пошуку: | #ComplexSearch – об'єкт для комплексного пошуку: | ||
*SearchString – string, рядок для пошуку; | *SearchString – string, рядок для пошуку; | ||
*SearchObjects – масив string, поля для пошуку: "GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard". | *SearchObjects – масив string, поля для пошуку: "GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard". | ||
'''Значення, що повертається:''' | '''Значення, що повертається:''' | ||
#Повертається JSON-структура з такими полями: | #Повертається JSON-структура з такими полями: | ||
#VersionInfo – string, версія API. | #VersionInfo – string, версія API. | ||
#RequestTime – string, час формування відповіді на сервері (UTC, мілісекунди). | #RequestTime – string, час формування відповіді на сервері (UTC, мілісекунди). | ||
#ErrorCode – string, код помилки: | #ErrorCode – string, код помилки: | ||
*0 – помилок немає. | *0 – помилок немає. | ||
#ErrorText – string, текст помилки, якщо вона є. | #ErrorText – string, текст помилки, якщо вона є. | ||
#Hotels – масив об'єктів з інформацією про готелі: | #Hotels – масив об'єктів з інформацією про готелі: | ||
#HotelInformation – об'єкт: | #HotelInformation – об'єкт: | ||
*HotelID – int, ідентифікатор готелю; | *HotelID – int, ідентифікатор готелю; | ||
*HotelName – string, назва готелю; | *HotelName – string, назва готелю; | ||
*HotelShortName – string, коротка назва готелю. | *HotelShortName – string, коротка назва готелю. | ||
#Guests – масив гостей, які відповідають фільтрам: | #Guests – масив гостей, які відповідають фільтрам: | ||
#Room – об'єкт:<br> | #Room – об'єкт:<br> | ||
*RoomId – int, ідентифікатор номера; | *RoomId – int, ідентифікатор номера; | ||
*RoomNumber – string, номер кімнати; | *RoomNumber – string, номер кімнати; | ||
*Floor – string, поверх; | *Floor – string, поверх; | ||
#RoomType – об'єкт:<br> | #RoomType – об'єкт:<br> | ||
*RoomTypeName – string, назва типу кімнати;<br> | *RoomTypeName – string, назва типу кімнати;<br> | ||
*RoomTypeShortName* | *RoomTypeShortName* |
Версія за 15:07, 20 травня 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*