T: відмінності між версіями

Матеріал з expertsolution
Перейти до навігації Перейти до пошуку
Немає опису редагування
Немає опису редагування
Рядок 22: Рядок 22:
#Preferences – масив об'єктів з полями:<br>
#Preferences – масив об'єктів з полями:<br>
*Code – string, код переваги;<br>
*Code – string, код переваги;<br>
*Value – string, значення переваги.<br>
*Value – string, значення переваги.
#ComplexSearch – об'єкт для комплексного пошуку:<br>
#ComplexSearch – об'єкт для комплексного пошуку:
*SearchString – string, рядок для пошуку;<br>
*SearchString – string, рядок для пошуку;
*SearchObjects – масив string, поля для пошуку: "GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard".<br>
*SearchObjects – масив string, поля для пошуку: "GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard".


'''Значення, що повертається:'''
'''Значення, що повертається:'''
#Повертається JSON-структура з такими полями:<br>
#Повертається JSON-структура з такими полями:
#VersionInfo – string, версія API.<br>
#VersionInfo – string, версія API.
#RequestTime – string, час формування відповіді на сервері (UTC, мілісекунди).<br>
#RequestTime – string, час формування відповіді на сервері (UTC, мілісекунди).
#ErrorCode – string, код помилки:<br>
#ErrorCode – string, код помилки:
*0 – помилок немає.<br>
*0 – помилок немає.
#ErrorText – string, текст помилки, якщо вона є.<br>
#ErrorText – string, текст помилки, якщо вона є.
#Hotels – масив об'єктів з інформацією про готелі:<br>
#Hotels – масив об'єктів з інформацією про готелі:
#HotelInformation – об'єкт:<br>
#HotelInformation – об'єкт:
   *HotelID – int, ідентифікатор готелю;
   *HotelID – int, ідентифікатор готелю;
   *HotelName – string, назва готелю;
   *HotelName – string, назва готелю;
*HotelShortName – string, коротка назва готелю.<br>
*HotelShortName – string, коротка назва готелю.
#Guests – масив гостей, які відповідають фільтрам:<br>
#Guests – масив гостей, які відповідають фільтрам:
#Room – об'єкт:<br>
#Room – об'єкт:<br>
*RoomId – int, ідентифікатор номера;<br>
*RoomId – int, ідентифікатор номера;
*RoomNumber – string, номер кімнати;<br>
*RoomNumber – string, номер кімнати;
*Floor – string, поверх;<br>
*Floor – string, поверх;
#RoomType – об'єкт:<br>
#RoomType – об'єкт:<br>
*RoomTypeName – string, назва типу кімнати;<br>
*RoomTypeName – string, назва типу кімнати;<br>
*RoomTypeShortName*
*RoomTypeShortName*

Версія за 15:07, 20 травня 2025

Опис функцій спілкування

GetGuestsModified

Функція GetGuestsModified повертає інформацію про гостей готелю, що були змінені після вказаної дати, або помилку.
Вхідні параметри:

  1. Credentials – облікові дані користувача:
  2. UserName – string, ім’я користувача;
  3. Password – string, пароль користувача.
  4. Hotels – масив ідентифікаторів готелів (якщо 0 – усі доступні).
  5. ModifiedDateFrom – string, "yyyy-MM-dd HH:mm:ss", дата та час, з якого враховувати зміни (необов’язково).
  6. GuestsID – масив string, фільтр за ідентифікаторами гостей (необов’язково).
  7. GuestStatus – масив int, статуси гостей:0 – заброньовані;2 – проживають;3 – виїхали;1 – анульовано;2 – незаїзд.
  8. isNeedCostInfo – string (0/1), чи виводити інформацію про вартість (0 – ні, за замовчуванням).
  9. ServiceClasses – масив string, коди класів послуг, що враховуються у вартість.
  10. ExcludeServiceSubclasses – масив string, коди підкласів послуг, що не враховуються у вартість.
  11. isNeedClientInfo – string (0/1), чи виводити анкетні дані (0 – ні, за замовчуванням).
  12. isNeedClientPhoto – string (0/1), чи вивантажувати фото клієнта.
  13. isNeedDocumentsInfo – string (0/1), чи виводити дані документів.
  14. GuestName – string, ПІБ гостя (необов’язково).
  15. PhoneNumber – string, телефон гостя (необов’язково).
  16. Mail – string, електронна пошта гостя (необов’язково).
  17. ClientID – int, ідентифікатор анкети гостя (необов’язково).
  18. Preferences – масив об'єктів з полями:
  • Code – string, код переваги;
  • Value – string, значення переваги.
  1. ComplexSearch – об'єкт для комплексного пошуку:
  • SearchString – string, рядок для пошуку;
  • SearchObjects – масив string, поля для пошуку: "GuestName", "Phone", "Email", "RoomNumber", "AccountNumber", "IdentityCard".

Значення, що повертається:

  1. Повертається JSON-структура з такими полями:
  2. VersionInfo – string, версія API.
  3. RequestTime – string, час формування відповіді на сервері (UTC, мілісекунди).
  4. ErrorCode – string, код помилки:
  • 0 – помилок немає.
  1. ErrorText – string, текст помилки, якщо вона є.
  2. Hotels – масив об'єктів з інформацією про готелі:
  3. HotelInformation – об'єкт:
  *HotelID – int, ідентифікатор готелю;
  *HotelName – string, назва готелю;
  • HotelShortName – string, коротка назва готелю.
  1. Guests – масив гостей, які відповідають фільтрам:
  2. Room – об'єкт:
  • RoomId – int, ідентифікатор номера;
  • RoomNumber – string, номер кімнати;
  • Floor – string, поверх;
  1. RoomType – об'єкт:
  • RoomTypeName – string, назва типу кімнати;
  • RoomTypeShortName*