openapi-directory/api/hetras-certification.net/hotel.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"hetras Hotel API Version 0","version":"v0","x-logo":{"url":"https://twitter.com/hetras/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://developer.hetras.com/swagger/spec/HotelAPIv0.json","version":"2.0"}],"x-providerName":"hetras-certification.net","x-serviceName":"hotel"},"paths":{"/api/hotel/v0/hotels":{"get":{"deprecated":false,"description":"Load the details about all the hotels your application has access to.","operationId":"Hotels_GetHotels","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}}],"responses":{"200":{"description":"A list of hotels.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Hotel"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/Hotel"},"type":"array"}}}},"204":{"description":"You don´t have access to any hotels."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get a list of all the hotels of a chain your application has access to.","tags":["Hotels"]}},"/api/hotel/v0/hotels/{hotelId}":{"get":{"deprecated":false,"description":"Load the details about the specified hotel.","operationId":"Hotels_GetHotel","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The details about the hotel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Hotel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Hotel"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get the details of the hotel with the speccified hotel id.","tags":["Hotels"]}},"/api/hotel/v0/hotels/{hotelId}/codes":{"get":{"deprecated":false,"description":"With this call you can find codes for a hotel by type or code. By default and without any filter criteria\r\n            defined it will return you all available codes.","operationId":"Codes_GetCodes","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id you are trying to find codes for.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Return all results matching the specified code. A code is unique in combination with the type\r\n            which means when you query for a code you could get multiple results each for a different type","in":"query","name":"code","required":false,"schema":{"type":"string"}},{"description":"Return all codes for the specified type","in":"query","name":"type","required":false,"schema":{"type":"string","enum":["GuestRequest","RequestDietary","VIPStatus","ReasonForRateChange","Regrets","MarketSegments","SourceOfBusiness","LoyaltyProgram","CancellationReason","AccountType","AccountRank","VIPLevel","Title","ContactFunction","Territory","CorrespondenceType","ExternalProgramType","RevenueBucket","AdditionalRevenueBucket","AdditionalStatisticsBuckets","MealPeriod","BillingCycle","ReminderCycle","MajorMarketSegments","DocumentType","ActivityType","ReservationLabels"]}}],"responses":{"200":{"description":"A list of codes for a requested hotel matching the filter criteria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodesListResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/CodesListResponse"}}}},"204":{"description":"There are no codes found for the given filtering criteria."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get a list of codes for the specified hotel either filtered by type or code.","tags":["Codes"]}},"/api/hotel/v0/hotels/{hotelId}/codes/{id}":{"get":{"deprecated":false,"description":"Read the details about a specific code available for the defined hotel.","operationId":"Codes_GetCode","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the code available for.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The code identifier you want to see details for.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Details for the given code and hotel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CodeFullEntry"}},"text/json":{"schema":{"$ref":"#/components/schemas/CodeFullEntry"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested rateplan could not be found."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get all the details for a specific code available for the hotel.","tags":["Codes"]}},"/api/hotel/v0/hotels/{hotelId}/rateplans":{"get":{"deprecated":false,"description":"With this call you can find rateplans for a hotel by different filters. By default and without any filter criteria\r\n            defined it will return you all active rateplans.","operationId":"RatePlans_GetRateplans","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id you are trying to find rateplans for.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Specify which rateplans to return. If you do not specify a value you will by default get active\r\n            rateplans.","in":"query","name":"sellingStatus","required":false,"schema":{"type":"string","enum":["Active","Inactive","All"]}},{"description":"Return all rateplans having commisionable status","in":"query","name":"commissionable","required":false,"schema":{"type":"boolean"}},{"description":"Return all rateplans belonging to the specified rateplan group","in":"query","name":"group","required":false,"schema":{"type":"string"}},{"description":"Return all rateplans having the specified rateplan as base rateplan","in":"query","name":"baseRateplan","required":false,"schema":{"type":"string"}},{"description":"Return all rateplans that are sold through at least one channel out of the specified channel group","in":"query","name":"channelGroup","required":false,"schema":{"type":"string"}},{"description":"Return all rateplans sold through the specified channel","in":"query","name":"channelCode","required":false,"schema":{"type":"string"}},{"description":"Return all rateplans having one of the specified values as a market code","in":"query","name":"marketCodes","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return all rateplans by which at least one of the specified room types are sold","in":"query","name":"roomTypes","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return all rateplans having at least one of the specified services included","in":"query","name":"includedServices","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Amount of items to skip.","in":"query","name":"skip","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Amount of items to select.","in":"query","name":"top","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Return total number of items for a given filter criteria.","in":"query","name":"inlinecount","required":false,"schema":{"type":"string","enum":["None","AllPages"]}}],"responses":{"200":{"description":"A list of rateplans for a requested hotel matching the filter criteria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateplansListResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RateplansListResponse"}}}},"204":{"description":"There are no rateplans found for the given filtering and pagination criteria."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get a list of rateplans for the specified hotel id matching the filter criteria.","tags":["RatePlans"]}},"/api/hotel/v0/hotels/{hotelId}/rateplans/$count":{"get":{"deprecated":false,"operationId":"RatePlans_GetRateplansCount","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel you are counting the rateplans for.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Specify which rateplans to return. If you do not specify a value you will by default get active\r\n            rateplans.","in":"query","name":"sellingStatus","required":false,"schema":{"type":"string","enum":["Active","Inactive","All"]}},{"description":"Return all rateplans having commisionable status","in":"query","name":"commissionable","required":false,"schema":{"type":"boolean"}},{"description":"Return all rateplans belonging to the specified rateplan group","in":"query","name":"group","required":false,"schema":{"type":"string"}},{"description":"Return all rateplans having the specified rateplan as base rateplan","in":"query","name":"baseRateplan","required":false,"schema":{"type":"string"}},{"description":"Return all rateplans that are sold through at least one channel out of the specified channel group","in":"query","name":"channelGroup","required":false,"schema":{"type":"string"}},{"description":"Return all rateplans sold through the specified channel","in":"query","name":"channelCode","required":false,"schema":{"type":"string"}},{"description":"Return all rateplans having one of the specified values as a market code","in":"query","name":"marketCodes","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return all rateplans by which at least one of the specified room types are sold","in":"query","name":"roomTypes","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return all rateplans having at least one of the specified services included","in":"query","name":"includedServices","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The rateplans count in the hotel matching the given filter criteria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotalCountResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/TotalCountResponse"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get the count of all rateplans in the hotel matching the given filter criteria.","tags":["RatePlans"]}},"/api/hotel/v0/hotels/{hotelId}/rateplans/batch/$rates":{"put":{"deprecated":false,"description":"Currently this call only allows to set the base price for non-derived rateplans if the rateplan\r\n            is active and already loaded for the specified time period.\r\n            <br /><br />\r\n            A request example:<br /><pre>\r\n            [\r\n              {\r\n                \"rateplan\": \"STDN01\", \"from\": \"2018-01-01\", \"to\": \"2018-01-30\", \"base_price\": 120.00\r\n              }\r\n            ]\r\n            </pre><br />\r\n            For more details on how the API responds to errors please check our documentation on \r\n            <a href=\"https://developer.hetras.com/docs/errors/\" onfocus=\"this.blur()\">Error Handling</a>.<br />","operationId":"RatePlans_BatchUpdateRates","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the rateplan belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RatesBatchUpdateRequestItem"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/RatesBatchUpdateRequestItem"},"type":"array"}}},"required":true},"responses":{"200":{"description":"The update was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"Bad request. Request body erroneous."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Update a list of base rateplans for a given period and a given base price for single occupancy.","tags":["RatePlans"]}},"/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}":{"get":{"deprecated":false,"description":"Read the details about a specific rateplan for the defined hotel.","operationId":"RatePlans_GetRateplan","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the rateplan belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The code of the rateplan you want to see details for.","in":"path","name":"rateplanCode","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Rateplan details for the given rateplan and hotel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendedRateplanEntry"}},"text/json":{"schema":{"$ref":"#/components/schemas/ExtendedRateplanEntry"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested rateplan could not be found."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get all the details for a specific rateplan in the hotel.","tags":["RatePlans"]}},"/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates":{"get":{"deprecated":false,"description":"With this call you can read the daily rates setup including the cancellation policy and minimum guarantee per day for the\r\n            specified rateplan. You can specify a timeperiod to read the daily rates for. The rateplan needs to be active for at least\r\n            one business day in the defined time period and have rates loaded.","operationId":"RatePlans_GetRates","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the rateplan belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The code of the rateplan you want to see details for.","in":"path","name":"rateplanCode","required":true,"schema":{"type":"string"}},{"description":"You can expand the supplements per room type on demand. By default they are not shown.","in":"query","name":"expand","required":false,"schema":{"type":"string","enum":["RoomTypeSupplements"]}},{"description":"Defines the last business day you would like to get rates for. The maximum time span between <i>from</i>´and <i>to</i>\r\n            is limited to 365 days.","in":"query","name":"from","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"Defines the first business day you would like to get rates for.","in":"query","name":"to","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"Amount of items to skip.","in":"query","name":"skip","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Amount of items to select.","in":"query","name":"top","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Return total number of items for a given filter criteria.","in":"query","name":"inlinecount","required":false,"schema":{"type":"string","enum":["None","AllPages"]}}],"responses":{"200":{"description":"List of daily rates within the specified time preiod.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatesResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RatesResponse"}}}},"204":{"description":"The rateplan does not have any active date or is not loaded within the defined time period."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested rateplan could not be found."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get the setup of the daily rates for a specific rateplan and a defined timeperiod.","tags":["RatePlans"]},"patch":{"deprecated":false,"description":"The hetras API is using this <a href=\"https://developer.hetras.com/docs/patch\" onfocus=\"this.blur()\" target=\"_blank\">Patch Specification</a>\r\n            to partially update an existing resource. Currently this call only allows to set the base price for non-derived rateplans if the rateplan\r\n            is active and already loaded for the specified time period.\r\n            <br /><br />\r\n            A request example:<br /><pre>\r\n            [\r\n              {\r\n                \"op\": \"replace\", \"path\": \"/base_price\", \"value\": 120.00\r\n              }\r\n            ]\r\n            </pre><br />\r\n            For more details on how the API responds to errors please check our documentation on \r\n            <a href=\"https://developer.hetras.com/docs/errors/\" onfocus=\"this.blur()\">Error Handling</a>.<br />","operationId":"RatePlans_PatchRates","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the rateplan belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The code of the rateplan you want to update the daily rate details for.","in":"path","name":"rateplanCode","required":true,"schema":{"type":"string"}},{"description":"Defines the last business day you would like to get rates for. The maximum time span between <i>from</i>´and <i>to</i>\r\n            is limited to 365 days.","in":"query","name":"from","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"Defines the first business day you would like to get rates for.","in":"query","name":"to","required":true,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"$ref":"#/components/requestBodies/JsonPatchDocument_RatePatchRequest_"},"responses":{"200":{"description":"The update was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"Bad request. Request body erroneous."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Partially update a rate of the specified rateplan for the defined time period.","tags":["RatePlans"]}},"/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/$count":{"get":{"deprecated":false,"operationId":"RatePlans_GetRatesCount","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the rateplan belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The code of the rateplan you want to count daily rates for.","in":"path","name":"rateplanCode","required":true,"schema":{"type":"string"}},{"description":"Defines the last business day you would like to get rates for. The maximum time span between <i>from</i>´and <i>to</i>\r\n            is limited to 365 days.","in":"query","name":"from","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"Defines the first business day you would like to get rates for.","in":"query","name":"to","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"The count of daily rates for the specified time period.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotalCountResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/TotalCountResponse"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested room could not be found."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get the count of all active and loaded daily rates for the defined rateplan in a specified time period.","tags":["RatePlans"]}},"/api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/{businessDay}":{"get":{"deprecated":false,"description":"Read the setup of the daily rate for the defined rateplan for that specific business day.","operationId":"RatePlans_GetRate","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the rateplan belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The code of the rateplan you want to see details for.","in":"path","name":"rateplanCode","required":true,"schema":{"type":"string"}},{"description":"The business day you want to get the rate setup for.","in":"path","name":"businessDay","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Daily rate with room type supplements for the specified rateplan and business day.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RateResponse"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested\r\n            rateplan could not be found or the rate is inactive on this business day."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get the setup of a daily rate for a specific business day and rateplan.","tags":["RatePlans"]},"patch":{"deprecated":false,"description":"The hetras API is using this <a href=\"https://developer.hetras.com/docs/patch\" onfocus=\"this.blur()\" target=\"_blank\">Patch Specification</a>\r\n            to partially update an existing resource. Currently this call only allows to set the base price for non-derived rateplans if the rateplan\r\n            is active and already loaded for the specified business day.\r\n            <br /><br />\r\n            A request example:<br /><pre>\r\n            [\r\n              {\r\n                \"op\": \"replace\", \"path\": \"/base_price\", \"value\": 120.00\r\n              }\r\n            ]\r\n            </pre><br />\r\n            For more details on how the API responds to errors please check our documentation on \r\n            <a href=\"https://developer.hetras.com/docs/errors/\" onfocus=\"this.blur()\">Error Handling</a>.<br />","operationId":"RatePlans_PatchRate","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the rateplan belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The code of the rateplan you want to update the daily rate details for.","in":"path","name":"rateplanCode","required":true,"schema":{"type":"string"}},{"description":"The business day of the daily rate you want to update.","in":"path","name":"businessDay","required":true,"schema":{"type":"string","format":"date-time"}}],"requestBody":{"$ref":"#/components/requestBodies/JsonPatchDocument_RatePatchRequest_"},"responses":{"200":{"description":"The update was successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"text/json":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"Bad request. Request body erroneous."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Partially update a rate of the specified rateplan for a defined business day.","tags":["RatePlans"]}},"/api/hotel/v0/hotels/{hotelId}/room_types":{"get":{"deprecated":false,"description":"With this call you can load the details about a all available room types for the specified hotel.","operationId":"RoomTypes_GetRoomTypes","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the room type belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"A list of room types for the given hotel.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RoomType"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/RoomType"},"type":"array"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested room could not be found."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get a list with the details of all room types for for the specified hotel id.","tags":["RoomTypes"]}},"/api/hotel/v0/hotels/{hotelId}/room_types/{code}":{"get":{"deprecated":false,"description":"With this call you can load the details about a specific room type in the hotel.","operationId":"RoomTypes_GetRoomType","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the room type belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The code of the room type you want to see details for.","in":"path","name":"code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Room type details for the given room and hotel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomType"}},"text/json":{"schema":{"$ref":"#/components/schemas/RoomType"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested room could not be found."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get all the details for a specific room type in the hotel.","tags":["RoomTypes"]}},"/api/hotel/v0/hotels/{hotelId}/rooms":{"get":{"deprecated":false,"description":"Find all rooms for the hotel that match the specified filter criteria. The filtering will be done based on the current state of\r\n            the rooms.","operationId":"Rooms_GetRooms","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel you are trying to find rooms for.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Return results only for rooms that have the given frontdesk ocuppancy status.","in":"query","name":"occupancy","required":false,"schema":{"type":"string","enum":["Occupied","Vacant"]}},{"description":"Return results only for rooms that have the given room condition status.","in":"query","name":"conditions","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"enum":["CleanNotInspected","Clean","Dirty"],"type":"string"}}},{"description":"Return results only for rooms that have the given maintenance status.","in":"query","name":"maintenances","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"enum":["NotSet","None","OutOfInventory","OutOfOrder","OutOfService"],"type":"string"}}},{"description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types.","in":"query","name":"roomTypes","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of \r\n            amenity codes.","in":"query","name":"amenities","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of \r\n            view codes.","in":"query","name":"views","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of \r\n            location codes.","in":"query","name":"locations","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Amount of items to skip.","in":"query","name":"skip","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Amount of items to select.","in":"query","name":"top","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Return total number of items for a given filter criteria.","in":"query","name":"inlinecount","required":false,"schema":{"type":"string","enum":["None","AllPages"]}}],"responses":{"200":{"description":"A list of rooms for the hotel based on the set filter criteria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomListResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RoomListResponse"}}}},"204":{"description":"There are no rooms found for the given filtering and pagination criteria."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested room could not be found."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get a list of rooms using the provided filtering and pagination criteria.","tags":["Rooms"]}},"/api/hotel/v0/hotels/{hotelId}/rooms/$count":{"get":{"deprecated":false,"operationId":"Rooms_GetRoomsCount","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel you are counting the rooms for.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Return results only for rooms that have the given frontdesk ocuppancy status.","in":"query","name":"occupancy","required":false,"schema":{"type":"string","enum":["Occupied","Vacant"]}},{"description":"Return results only for rooms that have the given room condition status.","in":"query","name":"conditions","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"enum":["CleanNotInspected","Clean","Dirty"],"type":"string"}}},{"description":"Return results only for rooms that have the given maintenance status.","in":"query","name":"maintenances","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"enum":["NotSet","None","OutOfInventory","OutOfOrder","OutOfService"],"type":"string"}}},{"description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types.","in":"query","name":"roomTypes","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of \r\n            amenity codes.","in":"query","name":"amenities","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of \r\n            view codes.","in":"query","name":"views","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of \r\n            location codes.","in":"query","name":"locations","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The room count in the hotel matching the given filter criteria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TotalCountResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/TotalCountResponse"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested room could not be found."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get the count of all rooms in the hotel matching the given filter criteria.","tags":["Rooms"]}},"/api/hotel/v0/hotels/{hotelId}/rooms/available":{"get":{"deprecated":false,"operationId":"Rooms_GetAvailableRooms","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel you are looking for available rooms.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Rooms returned will not be assigned to a reservation or be under maintenance between this date\r\n            and the specified to date. Still there could be departing reservations or ending maintenances\r\n            for this date.","in":"query","name":"from","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"Rooms returned will not be assigned to a reservation or be under maintenance between the specified\r\n            from date and this date. Still there could be arriving reservations or beginning maintenances\r\n            for this date.","in":"query","name":"to","required":true,"schema":{"type":"string","format":"date-time"}},{"description":"Specifies number of adults the returned rooms will have to be able to house. The default value is 1.","in":"query","name":"adults","required":false,"schema":{"type":"string","format":"byte"}},{"description":"Should rooms that are set OutOfService in the defined time period be returned as available. By default\r\n            they are not.","in":"query","name":"includeOutOfService","required":false,"schema":{"type":"boolean"}},{"description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types.","in":"query","name":"roomTypes","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of \r\n            amenity codes.","in":"query","name":"amenities","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of \r\n            view codes.","in":"query","name":"views","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of \r\n            location codes.","in":"query","name":"locations","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"description":"Amount of items to skip.","in":"query","name":"skip","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Amount of items to select.","in":"query","name":"top","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Return total number of items for a given filter criteria.","in":"query","name":"inlinecount","required":false,"schema":{"type":"string","enum":["None","AllPages"]}}],"responses":{"200":{"description":"A list of available rooms in the specified time period.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoomListResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RoomListResponse"}}}},"204":{"description":"There are no available rooms found for the given criteria."},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested room could not be found."},"422":{"description":"The request failed to validate."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Request available rooms using a given criteria.","tags":["Rooms"]}},"/api/hotel/v0/hotels/{hotelId}/rooms/{roomNumber}":{"get":{"deprecated":false,"description":"With this call you can load the details about a specific room in the hotel. It will show you the current status of the room.","operationId":"Rooms_GetRoom","parameters":[{"description":"Application identifier","in":"header","name":"App-Id","required":true,"x-data-threescale-name":"app_ids","schema":{"type":"string"}},{"description":"Application key.","in":"header","name":"App-Key","required":true,"x-data-threescale-name":"app_keys","schema":{"type":"string"}},{"description":"The hotel id the room belongs to.","in":"path","name":"hotelId","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The room number you want to see details for.","in":"path","name":"roomNumber","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Room details for the given room and hotel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Room"}},"text/json":{"schema":{"$ref":"#/components/schemas/Room"}}}},"401":{"description":"You provided wrong credentials, or you reached your API limit."},"403":{"description":"The application does not have access to the requested resource."},"404":{"description":"Not Found. The server has not found anything matching the Request-URI or the requested room could not be found."},"500":{"description":"We caught an unexpected error on our side. Please report with providing the Hetras-Tracking-Id from the response headers and we will check the logfiles."},"503":{"description":"The server is currently unavailable. Please try later."}},"summary":"Get all the details for a specific room in the hotel.","tags":["Rooms"]},"patch":{"deprecated":false,"description":"The hetras API is using this <a href=\"https://developer.hetras.com/docs/patch\" onfocus=\"this.blur()\" target=\"_blank\">Patch Specification</a>\r\n            to partially update an existing resource. Currently this call only allows to modify condition and housekeeping occupancy status