{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:hetras-certification-hotel/hotels-get-hotels":{"get":{"operationId":"open_data_hetras_certification_hotel_hotels_get_hotels","summary":"Get a list of all the hotels of a chain your application has access to.","description":"GET /api/hotel/v0/hotels","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/hotels-get-hotel":{"get":{"operationId":"open_data_hetras_certification_hotel_hotels_get_hotel","summary":"Get the details of the hotel with the speccified hotel id.","description":"GET /api/hotel/v0/hotels/{hotelId}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/codes-get-codes":{"get":{"operationId":"open_data_hetras_certification_hotel_codes_get_codes","summary":"Get a list of codes for the specified hotel either filtered by type or code.","description":"GET /api/hotel/v0/hotels/{hotelId}/codes","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id you are trying to find codes for.","schema":{"type":"integer","description":"The hotel id you are trying to find codes for."}},{"name":"code","in":"query","required":false,"description":"Return all results matching the specified code. A code is unique in combination with the type which means when you query for a code you…","schema":{"type":"string","description":"Return all results matching the specified code. A code is unique in combination with the type which means when you query for a code you…"}},{"name":"type","in":"query","required":false,"description":"Return all codes for the specified type","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"],"description":"Return all codes for the specified type"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/codes-get-code":{"get":{"operationId":"open_data_hetras_certification_hotel_codes_get_code","summary":"Get all the details for a specific code available for the hotel.","description":"GET /api/hotel/v0/hotels/{hotelId}/codes/{id}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id the code available for.","schema":{"type":"integer","description":"The hotel id the code available for."}},{"name":"id","in":"query","required":true,"description":"The code identifier you want to see details for.","schema":{"type":"string","description":"The code identifier you want to see details for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-get-rateplans":{"get":{"operationId":"open_data_hetras_certification_hotel_rate_plans_get_rateplans","summary":"Get a list of rateplans for the specified hotel id matching the filter criteria.","description":"GET /api/hotel/v0/hotels/{hotelId}/rateplans","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id you are trying to find rateplans for.","schema":{"type":"integer","description":"The hotel id you are trying to find rateplans for."}},{"name":"sellingStatus","in":"query","required":false,"description":"Specify which rateplans to return. If you do not specify a value you will by default get active rateplans.","schema":{"type":"string","enum":["Active","Inactive","All"],"description":"Specify which rateplans to return. If you do not specify a value you will by default get active rateplans."}},{"name":"commissionable","in":"query","required":false,"description":"Return all rateplans having commisionable status","schema":{"type":"boolean","description":"Return all rateplans having commisionable status"}},{"name":"group","in":"query","required":false,"description":"Return all rateplans belonging to the specified rateplan group","schema":{"type":"string","description":"Return all rateplans belonging to the specified rateplan group"}},{"name":"baseRateplan","in":"query","required":false,"description":"Return all rateplans having the specified rateplan as base rateplan","schema":{"type":"string","description":"Return all rateplans having the specified rateplan as base rateplan"}},{"name":"channelGroup","in":"query","required":false,"description":"Return all rateplans that are sold through at least one channel out of the specified channel group","schema":{"type":"string","description":"Return all rateplans that are sold through at least one channel out of the specified channel group"}},{"name":"channelCode","in":"query","required":false,"description":"Return all rateplans sold through the specified channel","schema":{"type":"string","description":"Return all rateplans sold through the specified channel"}},{"name":"marketCodes","in":"query","required":false,"description":"Return all rateplans having one of the specified values as a market code","schema":{"type":"array","description":"Return all rateplans having one of the specified values as a market code"}},{"name":"roomTypes","in":"query","required":false,"description":"Return all rateplans by which at least one of the specified room types are sold","schema":{"type":"array","description":"Return all rateplans by which at least one of the specified room types are sold"}},{"name":"includedServices","in":"query","required":false,"description":"Return all rateplans having at least one of the specified services included","schema":{"type":"array","description":"Return all rateplans having at least one of the specified services included"}},{"name":"skip","in":"query","required":false,"description":"Amount of items to skip.","schema":{"type":"integer","description":"Amount of items to skip."}},{"name":"top","in":"query","required":false,"description":"Amount of items to select.","schema":{"type":"integer","description":"Amount of items to select."}},{"name":"inlinecount","in":"query","required":false,"description":"Return total number of items for a given filter criteria.","schema":{"type":"string","enum":["None","AllPages"],"description":"Return total number of items for a given filter criteria."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-get-rateplans-count":{"get":{"operationId":"open_data_hetras_certification_hotel_rate_plans_get_rateplans_count","summary":"Get the count of all rateplans in the hotel matching the given filter criteria.","description":"GET /api/hotel/v0/hotels/{hotelId}/rateplans/$count","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel you are counting the rateplans for.","schema":{"type":"integer","description":"The hotel you are counting the rateplans for."}},{"name":"sellingStatus","in":"query","required":false,"description":"Specify which rateplans to return. If you do not specify a value you will by default get active rateplans.","schema":{"type":"string","enum":["Active","Inactive","All"],"description":"Specify which rateplans to return. If you do not specify a value you will by default get active rateplans."}},{"name":"commissionable","in":"query","required":false,"description":"Return all rateplans having commisionable status","schema":{"type":"boolean","description":"Return all rateplans having commisionable status"}},{"name":"group","in":"query","required":false,"description":"Return all rateplans belonging to the specified rateplan group","schema":{"type":"string","description":"Return all rateplans belonging to the specified rateplan group"}},{"name":"baseRateplan","in":"query","required":false,"description":"Return all rateplans having the specified rateplan as base rateplan","schema":{"type":"string","description":"Return all rateplans having the specified rateplan as base rateplan"}},{"name":"channelGroup","in":"query","required":false,"description":"Return all rateplans that are sold through at least one channel out of the specified channel group","schema":{"type":"string","description":"Return all rateplans that are sold through at least one channel out of the specified channel group"}},{"name":"channelCode","in":"query","required":false,"description":"Return all rateplans sold through the specified channel","schema":{"type":"string","description":"Return all rateplans sold through the specified channel"}},{"name":"marketCodes","in":"query","required":false,"description":"Return all rateplans having one of the specified values as a market code","schema":{"type":"array","description":"Return all rateplans having one of the specified values as a market code"}},{"name":"roomTypes","in":"query","required":false,"description":"Return all rateplans by which at least one of the specified room types are sold","schema":{"type":"array","description":"Return all rateplans by which at least one of the specified room types are sold"}},{"name":"includedServices","in":"query","required":false,"description":"Return all rateplans having at least one of the specified services included","schema":{"type":"array","description":"Return all rateplans having at least one of the specified services included"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-batch-update-rates":{"post":{"operationId":"open_data_hetras_certification_hotel_rate_plans_batch_update_rates","summary":"Update a list of base rateplans for a given period and a given base price for single occupancy.","description":"PUT /api/hotel/v0/hotels/{hotelId}/rateplans/batch/$rates","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","hotelId","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"hotelId":{"type":"integer","description":"The hotel id the rateplan belongs to."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-get-rateplan":{"get":{"operationId":"open_data_hetras_certification_hotel_rate_plans_get_rateplan","summary":"Get all the details for a specific rateplan in the hotel.","description":"GET /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id the rateplan belongs to.","schema":{"type":"integer","description":"The hotel id the rateplan belongs to."}},{"name":"rateplanCode","in":"query","required":true,"description":"The code of the rateplan you want to see details for.","schema":{"type":"string","description":"The code of the rateplan you want to see details for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-get-rates":{"get":{"operationId":"open_data_hetras_certification_hotel_rate_plans_get_rates","summary":"Get the setup of the daily rates for a specific rateplan and a defined timeperiod.","description":"GET /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id the rateplan belongs to.","schema":{"type":"integer","description":"The hotel id the rateplan belongs to."}},{"name":"rateplanCode","in":"query","required":true,"description":"The code of the rateplan you want to see details for.","schema":{"type":"string","description":"The code of the rateplan you want to see details for."}},{"name":"expand","in":"query","required":false,"description":"You can expand the supplements per room type on demand. By default they are not shown.","schema":{"type":"string","enum":["RoomTypeSupplements"],"description":"You can expand the supplements per room type on demand. By default they are not shown."}},{"name":"from","in":"query","required":true,"description":"Defines the last business day you would like to get rates for. The maximum time span between from ´and to is limited to 365 days.","schema":{"type":"string","description":"Defines the last business day you would like to get rates for. The maximum time span between from ´and to is limited to 365 days."}},{"name":"to","in":"query","required":true,"description":"Defines the first business day you would like to get rates for.","schema":{"type":"string","description":"Defines the first business day you would like to get rates for."}},{"name":"skip","in":"query","required":false,"description":"Amount of items to skip.","schema":{"type":"integer","description":"Amount of items to skip."}},{"name":"top","in":"query","required":false,"description":"Amount of items to select.","schema":{"type":"integer","description":"Amount of items to select."}},{"name":"inlinecount","in":"query","required":false,"description":"Return total number of items for a given filter criteria.","schema":{"type":"string","enum":["None","AllPages"],"description":"Return total number of items for a given filter criteria."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-patch-rates":{"post":{"operationId":"open_data_hetras_certification_hotel_rate_plans_patch_rates","summary":"Partially update a rate of the specified rateplan for the defined time period.","description":"PATCH /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","hotelId","rateplanCode","from","to","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"hotelId":{"type":"integer","description":"The hotel id the rateplan belongs to."},"rateplanCode":{"type":"string","description":"The code of the rateplan you want to update the daily rate details for."},"from":{"type":"string","description":"Defines the last business day you would like to get rates for. The maximum time span between from ´and to is limited to 365 days."},"to":{"type":"string","description":"Defines the first business day you would like to get rates for."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-get-rates-count":{"get":{"operationId":"open_data_hetras_certification_hotel_rate_plans_get_rates_count","summary":"Get the count of all active and loaded daily rates for the defined rateplan in a specified time period.","description":"GET /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/$count","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id the rateplan belongs to.","schema":{"type":"integer","description":"The hotel id the rateplan belongs to."}},{"name":"rateplanCode","in":"query","required":true,"description":"The code of the rateplan you want to count daily rates for.","schema":{"type":"string","description":"The code of the rateplan you want to count daily rates for."}},{"name":"from","in":"query","required":true,"description":"Defines the last business day you would like to get rates for. The maximum time span between from ´and to is limited to 365 days.","schema":{"type":"string","description":"Defines the last business day you would like to get rates for. The maximum time span between from ´and to is limited to 365 days."}},{"name":"to","in":"query","required":true,"description":"Defines the first business day you would like to get rates for.","schema":{"type":"string","description":"Defines the first business day you would like to get rates for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-get-rate":{"get":{"operationId":"open_data_hetras_certification_hotel_rate_plans_get_rate","summary":"Get the setup of a daily rate for a specific business day and rateplan.","description":"GET /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/{businessDay}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id the rateplan belongs to.","schema":{"type":"integer","description":"The hotel id the rateplan belongs to."}},{"name":"rateplanCode","in":"query","required":true,"description":"The code of the rateplan you want to see details for.","schema":{"type":"string","description":"The code of the rateplan you want to see details for."}},{"name":"businessDay","in":"query","required":true,"description":"The business day you want to get the rate setup for.","schema":{"type":"string","description":"The business day you want to get the rate setup for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rate-plans-patch-rate":{"post":{"operationId":"open_data_hetras_certification_hotel_rate_plans_patch_rate","summary":"Partially update a rate of the specified rateplan for a defined business day.","description":"PATCH /api/hotel/v0/hotels/{hotelId}/rateplans/{rateplanCode}/rates/{businessDay}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","hotelId","rateplanCode","businessDay","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"hotelId":{"type":"integer","description":"The hotel id the rateplan belongs to."},"rateplanCode":{"type":"string","description":"The code of the rateplan you want to update the daily rate details for."},"businessDay":{"type":"string","description":"The business day of the daily rate you want to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/room-types-get-room-types":{"get":{"operationId":"open_data_hetras_certification_hotel_room_types_get_room_types","summary":"Get a list with the details of all room types for for the specified hotel id.","description":"GET /api/hotel/v0/hotels/{hotelId}/room_types","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id the room type belongs to.","schema":{"type":"integer","description":"The hotel id the room type belongs to."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/room-types-get-room-type":{"get":{"operationId":"open_data_hetras_certification_hotel_room_types_get_room_type","summary":"Get all the details for a specific room type in the hotel.","description":"GET /api/hotel/v0/hotels/{hotelId}/room_types/{code}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id the room type belongs to.","schema":{"type":"integer","description":"The hotel id the room type belongs to."}},{"name":"code","in":"query","required":true,"description":"The code of the room type you want to see details for.","schema":{"type":"string","description":"The code of the room type you want to see details for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rooms-get-rooms":{"get":{"operationId":"open_data_hetras_certification_hotel_rooms_get_rooms","summary":"Get a list of rooms using the provided filtering and pagination criteria.","description":"GET /api/hotel/v0/hotels/{hotelId}/rooms","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel you are trying to find rooms for.","schema":{"type":"integer","description":"The hotel you are trying to find rooms for."}},{"name":"occupancy","in":"query","required":false,"description":"Return results only for rooms that have the given frontdesk ocuppancy status.","schema":{"type":"string","enum":["Occupied","Vacant"],"description":"Return results only for rooms that have the given frontdesk ocuppancy status."}},{"name":"conditions","in":"query","required":false,"description":"Return results only for rooms that have the given room condition status.","schema":{"type":"array","description":"Return results only for rooms that have the given room condition status."}},{"name":"maintenances","in":"query","required":false,"description":"Return results only for rooms that have the given maintenance status.","schema":{"type":"array","description":"Return results only for rooms that have the given maintenance status."}},{"name":"roomTypes","in":"query","required":false,"description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types.","schema":{"type":"array","description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types."}},{"name":"amenities","in":"query","required":false,"description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of amenity codes.","schema":{"type":"array","description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of amenity codes."}},{"name":"views","in":"query","required":false,"description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of view codes.","schema":{"type":"array","description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of view codes."}},{"name":"locations","in":"query","required":false,"description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of location codes.","schema":{"type":"array","description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of location codes."}},{"name":"skip","in":"query","required":false,"description":"Amount of items to skip.","schema":{"type":"integer","description":"Amount of items to skip."}},{"name":"top","in":"query","required":false,"description":"Amount of items to select.","schema":{"type":"integer","description":"Amount of items to select."}},{"name":"inlinecount","in":"query","required":false,"description":"Return total number of items for a given filter criteria.","schema":{"type":"string","enum":["None","AllPages"],"description":"Return total number of items for a given filter criteria."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rooms-get-rooms-count":{"get":{"operationId":"open_data_hetras_certification_hotel_rooms_get_rooms_count","summary":"Get the count of all rooms in the hotel matching the given filter criteria.","description":"GET /api/hotel/v0/hotels/{hotelId}/rooms/$count","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel you are counting the rooms for.","schema":{"type":"integer","description":"The hotel you are counting the rooms for."}},{"name":"occupancy","in":"query","required":false,"description":"Return results only for rooms that have the given frontdesk ocuppancy status.","schema":{"type":"string","enum":["Occupied","Vacant"],"description":"Return results only for rooms that have the given frontdesk ocuppancy status."}},{"name":"conditions","in":"query","required":false,"description":"Return results only for rooms that have the given room condition status.","schema":{"type":"array","description":"Return results only for rooms that have the given room condition status."}},{"name":"maintenances","in":"query","required":false,"description":"Return results only for rooms that have the given maintenance status.","schema":{"type":"array","description":"Return results only for rooms that have the given maintenance status."}},{"name":"roomTypes","in":"query","required":false,"description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types.","schema":{"type":"array","description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types."}},{"name":"amenities","in":"query","required":false,"description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of amenity codes.","schema":{"type":"array","description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of amenity codes."}},{"name":"views","in":"query","required":false,"description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of view codes.","schema":{"type":"array","description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of view codes."}},{"name":"locations","in":"query","required":false,"description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of location codes.","schema":{"type":"array","description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of location codes."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rooms-get-available-rooms":{"get":{"operationId":"open_data_hetras_certification_hotel_rooms_get_available_rooms","summary":"Request available rooms using a given criteria.","description":"GET /api/hotel/v0/hotels/{hotelId}/rooms/available","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel you are looking for available rooms.","schema":{"type":"integer","description":"The hotel you are looking for available rooms."}},{"name":"from","in":"query","required":true,"description":"Rooms returned will not be assigned to a reservation or be under maintenance between this date and the specified to date. Still there…","schema":{"type":"string","description":"Rooms returned will not be assigned to a reservation or be under maintenance between this date and the specified to date. Still there…"}},{"name":"to","in":"query","required":true,"description":"Rooms returned will not be assigned to a reservation or be under maintenance between the specified from date and this date. Still there…","schema":{"type":"string","description":"Rooms returned will not be assigned to a reservation or be under maintenance between the specified from date and this date. Still there…"}},{"name":"adults","in":"query","required":false,"description":"Specifies number of adults the returned rooms will have to be able to house. The default value is 1.","schema":{"type":"string","description":"Specifies number of adults the returned rooms will have to be able to house. The default value is 1."}},{"name":"includeOutOfService","in":"query","required":false,"description":"Should rooms that are set OutOfService in the defined time period be returned as available. By default they are not.","schema":{"type":"boolean","description":"Should rooms that are set OutOfService in the defined time period be returned as available. By default they are not."}},{"name":"roomTypes","in":"query","required":false,"description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types.","schema":{"type":"array","description":"Return result only for rooms for the given room types. Allows to pass a comma-separated list of room types."}},{"name":"amenities","in":"query","required":false,"description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of amenity codes.","schema":{"type":"array","description":"Return result only for rooms having all of the given amenities. You can provide a comma seperated list of amenity codes."}},{"name":"views","in":"query","required":false,"description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of view codes.","schema":{"type":"array","description":"Return result only for rooms having at least one of the specified views. You can provide a comma seperated list of view codes."}},{"name":"locations","in":"query","required":false,"description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of location codes.","schema":{"type":"array","description":"Return result only for rooms having at least one of the specified locations. You can provide a comma seperated list of location codes."}},{"name":"skip","in":"query","required":false,"description":"Amount of items to skip.","schema":{"type":"integer","description":"Amount of items to skip."}},{"name":"top","in":"query","required":false,"description":"Amount of items to select.","schema":{"type":"integer","description":"Amount of items to select."}},{"name":"inlinecount","in":"query","required":false,"description":"Return total number of items for a given filter criteria.","schema":{"type":"string","enum":["None","AllPages"],"description":"Return total number of items for a given filter criteria."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rooms-get-room":{"get":{"operationId":"open_data_hetras_certification_hotel_rooms_get_room","summary":"Get all the details for a specific room in the hotel.","description":"GET /api/hotel/v0/hotels/{hotelId}/rooms/{roomNumber}","tags":["open-data"],"parameters":[{"name":"App-Id","in":"query","required":true,"description":"Application identifier","schema":{"type":"string","description":"Application identifier"}},{"name":"App-Key","in":"query","required":true,"description":"Application key.","schema":{"type":"string","description":"Application key."}},{"name":"hotelId","in":"query","required":true,"description":"The hotel id the room belongs to.","schema":{"type":"integer","description":"The hotel id the room belongs to."}},{"name":"roomNumber","in":"query","required":true,"description":"The room number you want to see details for.","schema":{"type":"string","description":"The room number you want to see details for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/rooms-patch-room":{"post":{"operationId":"open_data_hetras_certification_hotel_rooms_patch_room","summary":"Partially updates a room.","description":"PATCH /api/hotel/v0/hotels/{hotelId}/rooms/{roomNumber}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","hotelId","roomNumber","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"hotelId":{"type":"integer","description":"The hotel id the room belongs to."},"roomNumber":{"type":"string","description":"The room number of the room you would like to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:hetras-certification-hotel/yieldable-rates-save-prices":{"post":{"operationId":"open_data_hetras_certification_hotel_yieldable_rates_save_prices","summary":"Saves Yieldable Rate Prices for existing Yieldable Rateplan.","description":"PUT /api/hotel/v0/hotels/{hotelId}/yieldable_rateplans/{rateplanCode}/$rates","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["App-Id","App-Key","hotelId","rateplanCode","body"],"properties":{"App-Id":{"type":"string","description":"Application identifier"},"App-Key":{"type":"string","description":"Application key."},"hotelId":{"type":"integer","description":"Specifies the hotelId which identifies Hotel for which the operation will be performed."},"rateplanCode":{"type":"string","description":"Specifies the rateplanCode for which the operation will be performed."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}