API Functions

PMS REST API

Online documentation

Download Shared Library

API Functions

OperaApiController API Functions

GetRoomWithHKStatusListOpera (.../OperaApi/GetRoomWithHKStatusListOpera)
Get Rooms with HouseKeeping Statuses
Request Method: POST	GetRoomWithHKStatusListOperaRequest Request for to get rooms with housekeeping statuses of the hotel
Response	List< RoomWithHKStatusOpera > ?

SetHousekeepingStatusOpera (.../OperaApi/SetHousekeepingStatusOpera)
Change Housekeeping Status, Update HouseKeeping Discrepancies
Request Method: POST	SetHousekeepingStatusOperaRequest Request to Change Housekeeping Status, Update HouseKeeping Discrepancies
Response	SetHousekeepingStatusOperaResponse ?

GetHousekeepingSectionsOpera (.../OperaApi/GetHousekeepingSectionsOpera)
Get HouseKeeping Sections
Request Method: POST	GetHousekeepingSectionsOperaRequest Request to get housekeeping sections of the hotel
Response	List< HousekeepingSectionsOpera > ?

GetRoomListOpera (.../OperaApi/GetRoomListOpera)
Get Rooms
Request Method: POST	GetRoomListOperaRequest Request to get rooms of the hotel
Response	List< RoomOpera > ?

GetAddressGreetingListOpera (.../OperaApi/GetAddressGreetingListOpera)
Get Address Greeting List from Opera
Request Method: POST	GetAddressGreetingListOperaRequest Request to get Address Greeting List of the Opera hotel
Response	List< AddressGreetingOpera > ?

SetProfileVipCodeOpera (.../OperaApi/SetProfileVipCodeOpera)
Update Profile's Vip Code
Request Method: POST	SetProfileVipCodeOperaRequest Update Profile Vipcode Request
Response	SetProfileVipCodeOperaResponse ?

GetPmsMobileOperaDataSet (.../OperaApi/GetPmsMobileOperaDataSet)
Get data for PmsMobileOpera Needs PMS_MOBILE_OPERA licence product property
Request Method: POST	GetPmsMobileOperaDataSetRequest ?
Response	DataSet ?

PmsController API Functions

GetRateDetails (.../Pms/GetRateDetails)
Get Rate Details Only Suite8 supports this function
Request Method: POST	GetRateDetailsRequest Rate Header list
Response	List< RateDetailedHeader > Available rates

GetBillingInstructions (.../Pms/GetBillingInstructions)
Get Billing Instructions for a Reservation in a hotel Only Suite8 supports this function
Request Method: POST	GetBillingInstructionsRequest Request for getting Billing Instructions for a Reservation
Response	List< BillingInstruction > ?

SetBillingInstructions (.../Pms/SetBillingInstructions)
Save Billing Instruction info for a Reservation in a hotel Only Suite8 supports this function
Request Method: POST	SetBillingInstructionsRequest Request for setting Billing Instruction for a Reservation
Response	SetBillingInstructionsResponse ?

RemoveManualRateFlag (.../Pms/RemoveManualRateFlag)
Removes ManualRate Flag for a Reservation Only Suite8 supports this function
Request Method: POST	RemoveManualRateFlagRequest Remove ManualRate Flag for Reservation request object
Response	RemoveManualRateFlagResponse ?

GetHotels (.../Pms/GetHotels)
Gets defined hotels at system
Request Method: POST	RequestBase Request Base Object
Response	List< Hotel > list of hotels managed by this api

GetServiceInfo (.../Pms/GetServiceInfo)
Gets Service Status
Request Method: POST	RequestBase Request Base Object
Response	ServiceInfo status and versions info about the service

GuestLogin (.../Pms/GuestLogin)
Login based on Email with Password or RoomNumber with Password
Request Method: POST	GuestLoginRequest parameters to set Email/RoomNumber and Password
Response	Profile profile data.

CheckUserExists (.../Pms/CheckUserExists)
Check if there is an exiting user within the given email
Request Method: POST	CheckUserExistsRequest parameter to set user email
Response	bool true if user exists

SetPassword (.../Pms/SetPassword)
Set a new password to an user. Old Password or UserID should be given with email to change the password.
Request Method: POST	SetPasswordRequest parameters to set Email and OldPassword/UserID

CheckIn (.../Pms/CheckIn)
Makes Check-in
Request Method: POST	CheckInRequest parameters to set RoomNumber and ReservationID
Response	CheckInResponse nothing

Availability (.../Pms/Availability)
Gets the requested room availability info of the hotels
Request Method: POST	AvailabilityRequest parameters to set AvailabilityCriteria and AvailabilityRateSelection
Response	AvailabilityResponse the available rooms and rates for the given date and hotels

GetCurrencies (.../Pms/GetCurrencies)
Gets currencies
Request Method: POST	GetCurrenciesRequest parameters to set Language, HotelCode and AuthData
Response	GetCurrenciesResponse the currencies defined for the hotel

GetCurrentCurrencyRates (.../Pms/GetCurrentCurrencyRates)
[Deprecated] Use GetCurrencyRates method
Gets current currency rates
Request Method: POST	GetCurrentCurrencyRatesRequest parameters to set Language, HotelCode and AuthData
Response	List< CurrencyRate > rates for currency conversion

GetCurrencyRates (.../Pms/GetCurrencyRates)
Gets currency rates
Request Method: POST	GetCurrencyRatesRequest parameters to set Language, HotelCode and AuthData
Response	List< CurrencyRate > rates for currency conversion

GetProfile (.../Pms/GetProfile)
Gets Profile based on provided ProfileID or chain-wide global UserID
Request Method: POST	GetProfileRequest parameters to set required fields of profile
Response	List< Profile > profile data

GetRoomTypes (.../Pms/GetRoomTypes)
Gets room types of the hotel
Request Method: POST	GetRoomTypesRequest parameters to set Language, HotelCode and AuthData
Response	List< RoomType > room type list of hotel

GetDepartmentCodes (.../Pms/GetDepartmentCodes)
Gets DepartmentCode definitions of hotel Only implemented for Suite8
Request Method: POST	GetDepartmentCodesRequest parameters to set Language, HotelCode and AuthData
Response	List< DepartmentCode > DepartmentCode list of hotel

GetAddressTypes (.../Pms/GetAddressTypes)
Gets address types. This function returns an address type if it is written in the service configuration as below : - CommunicationMappings/DefaultAddressTypeCode - ConfigCodes with type ADDR
Request Method: POST	GetAddressTypesRequest parameters to set Language, HotelCode and AuthData
Response	List< AddressType > address type list of the hotel

GetCountries (.../Pms/GetCountries)
Gets countries
Request Method: POST	GetCountriesRequest parameters to set Language, HotelCode and AuthData
Response	List< Country > county list of the hotel

GetNationalities (.../Pms/GetNationalities)
Gets nationalities
Request Method: POST	GetNationalitiesRequest parameters to set Language, HotelCode and AuthData
Response	List< Nationality > nationality list of the hotel

GetNoteCategories (.../Pms/GetNoteCategories)
Gets Note Categories Only implemented for Suite8
Request Method: POST	GetNoteCategoriesRequest parameters to get Note Categories, HotelCode and AuthData
Response	List< NoteCategory > membership types list of the hotel

GetMemberShipTypes (.../Pms/GetMemberShipTypes)
Gets membership types Only implemented for Suite8
Request Method: POST	GetMemberShipTypesRequest parameters to get membership types, HotelCode and AuthData
Response	List< MemberShipTypes > membership types list of the hotel

SetMembership (.../Pms/SetMembership)
Insert/Update/Delete MemberShip
Request Method: POST	SetMemberShipRequest parameters to set required fields for MemberShip
Response	SetMemberShipResponse MemberShipID, if succeed

SetPersonalDocument (.../Pms/SetPersonalDocument)
Insert/Update/Delete PersonalDocument
Request Method: POST	SetPersonalDocumentRequest parameters to set required fields for PersonalDocument
Response	SetPersonalDocumentResponse PersonalDocumentID, if succeed

GetProfilesPersonalDocuments (.../Pms/GetProfilesPersonalDocuments)
Gets PersonalDocuments of a Profile in a Hotel
Request Method: POST	GetProfilesPersonalDocumentsRequest parameters to get PersonalDocument types: HotelCode, ProfileId and AuthData
Response	List< PersonalDocument > PersonalDocuments of Profile

GetPersonalDocumentTypes (.../Pms/GetPersonalDocumentTypes)
Gets PersonalDocument types
Request Method: POST	GetPersonalDocumentTypesRequest parameters to get PersonalDocument types: HotelCode and AuthData
Response	List< PersonalDocumentType > PersonalDocument types list of the hotel

GetLanguages (.../Pms/GetLanguages)
Gets languages. Use Language.HotelCode as reference to HotelCode Parameter of API functions.
Request Method: POST	GetLanguagesRequest parameters to set Language, HotelCode and AuthData
Response	List< Language > Returns Language List from specified Hotel. if HotelCode not specified it returns default hotel Languages.

GetChildCategories (.../Pms/GetChildCategories)
Gets child categories
Request Method: POST	GetChildCategoriesRequest parameters to set Language, HotelCode and AuthData
Response	List< ChildCategory > child category list of defined according to age of children

GetCommunicationTypes (.../Pms/GetCommunicationTypes)
Gets communication types
Request Method: POST	GetCommunicationTypesRequest parameters to set Language, HotelCode and AuthData
Response	List< CommunicationType > communication type list of the hotel

GetProfileTypes (.../Pms/GetProfileTypes)
Gets profile types
Request Method: POST	GetProfileTypesRequest parameters to set Language, HotelCode and AuthData
Response	List< ProfileType > profile type list of the hotel

GetCountryStates (.../Pms/GetCountryStates)
Gets states of a country
Request Method: POST	GetCountryStateRequest parameters to set CountryCode, Language, HotelCode and AuthData
Response	List< CountryState > states list of a country

SetReservationNotes (.../Pms/SetReservationNotes)
Add or update reservation notes
Request Method: POST	SetReservationNotesRequest parameters
Response	SetReservationNotesResponse isSuccessfull

SetReservation (.../Pms/SetReservation)
Make or update a reservation to a profile
Request Method: POST	SetReservationRequest parameters to set Profile and reservation criteria
Response	SetReservationResponse ReservationID, ProfileIdentity and IsProfileInserted

CancelReservation (.../Pms/CancelReservation)
Cancel reservation the given ReservationID
Request Method: POST	CancelReservationRequest parameters to set ReservationID
Response	CancelReservationResponse true if succeed

SetProfile (.../Pms/SetProfile)
Insert new profile or update the profile
Request Method: POST	SetProfileRequest parameters to set required fields for profile
Response	SetProfileResponse ProfileID, UserID if succeed

GetReservation (.../Pms/GetReservation)
Gets reservation in the hotel or all chain hotel
Request Method: POST	GetReservationRequest parameters to set searching criteria
Response	List< ReservationInfo > reservation list of searching result

GetReservationByIDList (.../Pms/GetReservationByIDList)
Gets reservations the given ReservationIDs
Request Method: POST	GetReservationByIDListRequest parameters to set ReservationIDs
Response	List< ReservationInfo > reservation list of the given ReservationIDs

GetReservationNotes (.../Pms/GetReservationNotes)
Gets Reservation Notes for the given ReservationID and NoteCategories
Request Method: POST	GetReservationNotesRequest parameters
Response	List< NoteItem > Reservation Notes list

GetCreditCardTypes (.../Pms/GetCreditCardTypes)
Gets credit card types
Request Method: POST	GetCreditCardTypesRequest parameters to set Language, HotelCode and AuthData
Response	List< CreditCardType > defined credit card types of the hotel

GetBankCodes (.../Pms/GetBankCodes)
Gets bank codes
Request Method: POST	RequestBase parameters to set Language, HotelCode and AuthData
Response	List< CCBankInfo > defined bank code list in config

GetBlockHeaders (.../Pms/GetBlockHeaders)
Gets block headers
Request Method: POST	GetBlockHeaderRequest parameters to set required block header fields
Response	List< BlockHeader > block header list of the hotel

GetBlockDetails (.../Pms/GetBlockDetails)
Gets block details
Request Method: POST	GetBlockDetailRequest parameters to set required block detail fields
Response	List< BlockDetail > block detail list of the hotel

GetHotelAvailability (.../Pms/GetHotelAvailability)
Returns full hotel availability status for a dayspan.
Request Method: POST	GetHotelAvailabilityRequest Availability start/end dates
Response	List< HotelAvailability > List of availability status for each day

GetExtendedHotelInfo (.../Pms/GetExtendedHotelInfo)
Gets hotel information
Request Method: POST	GetExtendedHotelInfoRequest parameters to set LanguageCode
Response	ExtendedHotelInformation contact information of the hotel

GetPackages (.../Pms/GetPackages)
Returns the list of packages defined in the hotel. This method retuns both the package definitions and their prices.
Request Method: POST	GetPackagesRequest package request criteria
Response	List< Package > list of package definitions

GetAttributeTypes (.../Pms/GetAttributeTypes)
Returns the list of attribute (preference in Opera) groups/categories defined in the hotel. Ex: Newspappers
Request Method: POST	GetAttributeTypesRequest attribute type request criteria
Response	List< AttributeType > list of attribute type definitions

GetAttributeItems (.../Pms/GetAttributeItems)
Returns the list of attribute (preference in Opera) items defined in the hotel.
Request Method: POST	GetAttributeItemsRequest attribute item request criteria
Response	List< AttributeItem > list of attribute item definitions

ApproveCCPayment (.../Pms/ApproveCCPayment)
This api approves an external reservation payment (If the payment of an inserted reservation pre-authorized externally, this is the post approvement of the cycle) Only implemented for Suite8
Request Method: POST	ApproveCCPaymentRequest information needed to approve
Response	ApproveCCPaymentResponse succeeded if http 200 is returned

CheckService (.../Pms/CheckService)
Check Ows/Ifc and DB connection
Request Method: POST	RequestBase Request base
Response	string Result message

GetRates (.../Pms/GetRates)
Get Rates
Request Method: POST	GetRatesRequest Rate Header list
Response	List< RateHeader > Available rates

GetChannels (.../Pms/GetChannels)
Gets all the channel definitions in the hotel.
Request Method: POST	GetChannelsRequest HotelCode and AuthData parameters
Response	List< Channel > Returns Channel list from specified hotel.

GetSources (.../Pms/GetSources)
Gets all the source definitions in the hotel.
Request Method: POST	GetSourcesRequest HotelCode and AuthData parameters
Response	List< Source > Returns Source list from specified hotel.

GetMarkets (.../Pms/GetMarkets)
Gets all the market definitions in the hotel.
Request Method: POST	GetMarketsRequest HotelCode and AuthData parameters
Response	List< Market > Returns Market list from specified hotel.

GetGreetings (.../Pms/GetGreetings)
Gets address & letter greetings.
Request Method: POST	GetGreetingsRequest Language, Type and Gender parameters
Response	List< Greeting > Returns greetings title.

SetPosting (.../Pms/SetPosting)
Insert a posting to Pms department
Request Method: POST	SetPostingRequest posting details
Response	SetPostingResponse Returns posting result information.

GetGuaranteeCodes (.../Pms/GetGuaranteeCodes)
Gets guarantees of the hotel Only implemented for Suite8
Request Method: POST	GetGuaranteeCodesRequest parameters to set Language, HotelCode and AuthData
Response	List< Guarantee > guarantee type list of hotel

GetPaymentTypes (.../Pms/GetPaymentTypes)
Gets Payment Types of the hotel
Request Method: POST	GetPaymentTypesRequest parameters to set Language, HotelCode and AuthData
Response	List< PaymentType > Payment Type list of hotel

GetHotelSeasons (.../Pms/GetHotelSeasons)
Get Seasons of the hotel Only implemented for Opera
Request Method: POST	GetHotelSeasonsRequest parameters to set HotelCode and AuthData
Response	List< HotelSeason > Seasons of the hotel

GetApplicationSettings (.../Pms/GetApplicationSettings)
Get App Settings of the hotel
Request Method: POST	GetApplicationSettingsRequest parameters to set HotelCode and AuthData
Response	List< ApplicationSetting > App Settings of the hotel

GetRebateCodes (.../Pms/GetRebateCodes)
Gets Rebate Codes Only Suite8 supports this function, Only implemented for Suite8
Request Method: POST	GetRebateCodesRequest parameters to set Language, HotelCode and AuthData
Response	List< RebateCode > Payment Type list of hotel

GetGuestCommentCategories (.../Pms/GetGuestCommentCategories)
Gets all Guest Comment Categories in a hotel Only Suite8 supports this function
Request Method: POST	GetGuestCommentCategoriesRequest Request for to get defined Guest Comment Category list of the hotel
Response	List< GuestCommentCategory > ?

GetGuestTempers (.../Pms/GetGuestTempers)
Gets all Guest Tempers in a hotel Only Suite8 supports this function
Request Method: POST	GetGuestTempersRequest Request for to get defined Guest Tempers list of the hotel
Response	List< GuestTemper > ?

GetGuestComments (.../Pms/GetGuestComments)
Gets Guest Comments for a profile in a hotel Only Suite8 supports this function
Request Method: POST	GetGuestCommentsRequest ?
Response	List< GuestCommentView > ?

SetGuestComments (.../Pms/SetGuestComments)
Save Guest Comment info for a profile in a hotel Only Suite8 supports this function
Request Method: POST	SetGuestCommentsRequest Request for setting Guest Comments for a Profile
Response	SetGuestCommentsResponse ?

GetReservationAttributeCategories (.../Pms/GetReservationAttributeCategories)
Get Reservation Attribute Categories in a hotel Only Suite8 supports this function
Request Method: POST	GetReservationAttributeCategoriesRequest Request for to get defined Reservation Attribute Category list of the hotel
Response	List< ReservationAttributeCategory > ?

GetReservationAttributeItems (.../Pms/GetReservationAttributeItems)
Get Reservation Attribute Items for Reservation Attribute Categories in a hotel Only Suite8 supports this function
Request Method: POST	GetReservationAttributeItemsRequest Request for to get defined Reservation Attribute Item list of the hotel
Response	List< ReservationAttributeItem > ?

GetReservationAttributes (.../Pms/GetReservationAttributes)
Get Reservation Attributes linked to a Reservation Only Suite8 supports this function
Request Method: POST	GetReservationAttributesRequest Request for to get defined Reservation Attribute list for the reservation
Response	List< ReservationAttribute > ?

SetReservationAttributes (.../Pms/SetReservationAttributes)
Set Reservation Attributes linked to a Reservation Only Suite8 supports this function
Request Method: POST	SetReservationAttributesRequest Request for setting a Guest Comment for a Profile
Response	SetReservationAttributesResponse ?

GetRoomWithHKStatusList (.../Pms/GetRoomWithHKStatusList)
Get Rooms with HouseKeeping Statuses Only Suite8 supports this function
Request Method: POST	GetRoomWithHKStatusListRequest Request for to get rooms with housekeeping statuses of the hotel
Response	List< RoomWithHKStatus > ?

GetHKStatuses (.../Pms/GetHKStatuses)
Get HouseKeeping Statuses Only Suite8 supports this function
Request Method: POST	GetHKStatusesRequest Request for to get defined Housekeeping Room Statuses of the hotel
Response	List< HKStatus > ?

SetRoomsHKStatus (.../Pms/SetRoomsHKStatus)
Set HouseKeeping Status of a Room Only Suite8 supports this function
Request Method: POST	SetRoomsHKStatusRequest Request for setting the housekeeping status of a room
Response	SetRoomsHKStatusResponse ?

GetReservationDailyDetails (.../Pms/GetReservationDailyDetails)
Get Daily Details a Reservation Only Suite8 supports this function
Request Method: POST	GetReservationDailyDetailsRequest Request for to get Daily Details for a reservation
Response	List< ReservationDailyDetail > ?

GetHotelMaintenances (.../Pms/GetHotelMaintenances)
Get Hotel Maintenances Only Suite8 supports this function
Request Method: POST	GetHotelMaintenancesRequest Get Hotel Maintenances
Response	List< HotelMaintenanceView > ?

GetEmployees (.../Pms/GetEmployees)
Get Employees Only Suite8 supports this function
Request Method: POST	GetEmployeesRequest Get Employees
Response	List< Employee > ?

GetMaintenanceTypes (.../Pms/GetMaintenanceTypes)
Get Maintenance Types Only Suite8 supports this function
Request Method: POST	GetMaintenanceTypesRequest Get Maintenance Types Request
Response	List< MaintenanceType > ?

GetOrigins (.../Pms/GetOrigins)
Get Origins Only Suite8 supports this function
Request Method: POST	GetOriginsRequest Get Origins
Response	List< Origin > ?

GetLocalities (.../Pms/GetLocalities)
Get Localities Only Suite8 supports this function
Request Method: POST	GetLocalitiesRequest Get Localities
Response	List< Locality > ?

GetStatusLevels (.../Pms/GetStatusLevels)
Get Status Levels Only Suite8 supports this function
Request Method: POST	GetStatusLevelsRequest Get Status Levels
Response	List< StatusLevel > ?

SetHotelMaintenance (.../Pms/SetHotelMaintenance)
Set a Hotel Maintenance Only Suite8 supports this function
Request Method: POST	SetHotelMaintenanceRequest Request for Insert,Update,Delete a Hotel Maintenance
Response	SetHotelMaintenanceResponse ?

GetReservationDailyAttributes (.../Pms/GetReservationDailyAttributes)
Get Reservation Daily Attributes of a Reservation Only Suite8 supports this function
Request Method: POST	GetReservationDailyAttributesRequest Request for to get defined Reservation Daily Attribute list for the reservation
Response	List< ReservationDailyAttribute > ?

GetRoomProblemStatuses (.../Pms/GetRoomProblemStatuses)
Get Room Problem Statuses OOO (Out Of Order), OOS (Out Of Service), DND (Do Not Disturb) ...
Request Method: POST	GetRoomProblemStatusesRequest Request for getting the Room Status Categories
Response	List< RoomProblemStatus > ?

GetRoomProblemReasons (.../Pms/GetRoomProblemReasons)
Get Room Problem Reasons Damage, Painting, Air Condition, Heating ...
Request Method: POST	GetRoomProblemReasonsRequest Request for getting the Room Status Categories
Response	List< RoomProblemStatus > ?

SetRoomProblemPeriod (.../Pms/SetRoomProblemPeriod)
Set Room Usage Status OOO (Out Of Order), OOS (Out Of Service), DND (Do Not Disturb) vs.
Request Method: POST	SetRoomProblemPeriodRequest Request for setting the usage status of a room
Response	SetRoomProblemPeriodResponse ?

GetDocumentGroups (.../Pms/GetDocumentGroups)
Get Document Groups Only Suite8 supports this function
Request Method: POST	GetDocumentGroupsRequest Request for to get defined Document Group list of the hotel
Response	List< DocumentGroup > ?

GetGuestDocuments (.../Pms/GetGuestDocuments)
Gets Guest Documents for a profile in a hotel Only Suite8 supports this function
Request Method: POST	GetGuestDocumentsRequest ?
Response	List< GuestDocumentView > ?

GetGuestDocumentContent (.../Pms/GetGuestDocumentContent)
Get Guest Document File Content for a profile or a reservation in a hotel Only Suite8 supports this function
Request Method: POST	GetGuestDocumentContentRequest Request to get Guest Document File Content
Response	GetGuestDocumentContentResponse ?

SetGuestDocuments (.../Pms/SetGuestDocuments)
Insert,Delete Guest Document info for a profile or a reservation in a hotel Only Suite8 supports this function
Request Method: POST	SetGuestDocumentsRequest Request for setting Guest Documents for a Profile
Response	SetGuestDocumentsResponse ?

Copyright © 2026 Protel A.Ş All Rights Reserved.