From 57e2e274f3b9b470208a2d9291e49ea292f39a68 Mon Sep 17 00:00:00 2001 From: mohnoor94 Date: Tue, 4 Feb 2025 15:52:33 +0300 Subject: [PATCH] chore: update specs --- specs.yaml | 5061 ++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 4271 insertions(+), 790 deletions(-) diff --git a/specs.yaml b/specs.yaml index 99ea261fb6..9056629889 100644 --- a/specs.yaml +++ b/specs.yaml @@ -458,41 +458,19 @@ paths: description: OK headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' Link: @@ -1065,19 +1043,19 @@ paths: enhanced_house_rules: Pets: rule: No pets allowed - additional_information: [] + additional_information: [ ] CheckOut: rule: Check out before 10:00 AM - additional_information: [] + additional_information: [ ] Events: rule: No events allowed - additional_information: [] + additional_information: [ ] MinBookingAge: rule: "Minimum age to rent: 21" - additional_information: [] + additional_information: [ ] Occupancy: rule: "Maximum overnight guests: 16 (sleeps up to 16 adults)" - additional_information: [] + additional_information: [ ] CustomRules: rule: No fireworks are permitted. Please respect our neighbors as many of them live here full time. Quiet hours are @@ -1087,13 +1065,13 @@ paths: \ or underage drinking is permitted." CheckIn: rule: Check in after 4:00 PM - additional_information: [] + additional_information: [ ] Children: rule: "Children allowed: ages 0-17" - additional_information: [] + additional_information: [ ] Smoking: rule: Smoking is not permitted - additional_information: [] + additional_information: [ ] free_text: "Stunning brand new 2-story home with 6 bedrooms,\ \ 4 bathrooms, brand new appliances/furniture, game room,\ \ grill, patio, and beautiful scenery all around. Minutes\ @@ -1821,46 +1799,24 @@ paths: amenities: "4.4" recommendation_percent: 90% No Properties Example: - value: {} + value: { } "400": description: Invalid Input headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -1960,41 +1916,19 @@ paths: description: Gone headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -2021,41 +1955,19 @@ paths: description: Too Many Requests headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -2090,7 +2002,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /properties/inactive: get: tags: @@ -2189,41 +2101,19 @@ paths: description: OK headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Link: description: | Contains a single link to get the immediate next page of results, and follows the @@ -2254,46 +2144,24 @@ paths: - property_id: "12345" - property_id: "23456" No Results: - value: [] + value: [ ] "400": description: Invalid Input headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' content: application/json: schema: @@ -2358,41 +2226,19 @@ paths: description: Gone headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' content: application/json: schema: @@ -2414,41 +2260,19 @@ paths: description: Too Many Requests headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' content: application/json: schema: @@ -2475,7 +2299,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /properties/{property_id}/guest-reviews: get: tags: @@ -2623,41 +2447,19 @@ paths: description: OK headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -2696,41 +2498,19 @@ paths: description: Invalid Input headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -2814,41 +2594,19 @@ paths: description: Not Found headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -2874,41 +2632,19 @@ paths: description: Too Many Requests headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -2943,7 +2679,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /files/properties/catalog: get: tags: @@ -3071,41 +2807,19 @@ paths: description: OK headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -3120,41 +2834,19 @@ paths: description: Invalid Input headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -3238,41 +2930,19 @@ paths: description: Not Found headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -3302,41 +2972,19 @@ paths: description: Too Many Requests headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -3371,7 +3019,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /files/properties/content: get: tags: @@ -3489,41 +3137,19 @@ paths: description: OK headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -3538,41 +3164,19 @@ paths: description: Invalid Input headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -3656,41 +3260,19 @@ paths: description: Not Found headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -3720,41 +3302,19 @@ paths: description: Too Many Requests headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -3789,7 +3349,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /regions: get: tags: @@ -4170,7 +3730,7 @@ paths: - id: "500001" type: continent No regions: - value: [] + value: [ ] "400": description: Bad Request headers: @@ -4443,7 +4003,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /regions/{region_id}: get: tags: @@ -4953,7 +4513,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /properties/geography: post: tags: @@ -5301,7 +4861,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /properties/availability: get: tags: @@ -5378,7 +4938,7 @@ paths: required: true schema: type: string - example: '2025-02-01' + example: '2025-04-01' - name: checkout in: query description: | @@ -5386,7 +4946,7 @@ paths: required: true schema: type: string - example: '2025-02-03' + example: '2025-04-03' - name: currency in: query description: | @@ -6247,7 +5807,7 @@ paths: href: /v3/properties/12345/availability?token=MY5S3j36cOcL score: 10052 No availability: - value: [] + value: [ ] "400": description: Bad Request headers: @@ -6456,7 +6016,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /properties/{property_id}/availability: get: tags: @@ -6555,7 +6115,7 @@ paths: If specified must also specify `checkout`. schema: type: string - example: '2025-02-01' + example: '2025-04-01' - name: checkout in: query description: | @@ -6564,7 +6124,7 @@ paths: If specified must also specify `checkin`.
schema: type: string - example: '2025-02-03' + example: '2025-04-03' - name: exclusion in: query description: | @@ -7024,7 +6584,7 @@ paths: href: /v3/properties/12345/availability?token=MY5S3j36cOcL score: 10052 No availability: - value: [] + value: [ ] "400": description: Bad Request headers: @@ -7229,7 +6789,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /properties/{property_id}/rooms/{room_id}/rates/{rate_id}: get: tags: @@ -7816,7 +7376,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /properties/{property_id}/payment-options: get: tags: @@ -8135,7 +7695,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /calendars/availability: get: tags: @@ -8220,7 +7780,7 @@ paths: schema: type: string format: date - example: '2025-02-15' + example: '2025-04-15' - name: end_date in: query description: | @@ -8229,7 +7789,7 @@ paths: schema: type: string format: date - example: '2025-08-17' + example: '2025-10-17' responses: "200": description: OK @@ -8318,7 +7878,7 @@ paths: min_stay: 1 max_stay: 5 No Results: - value: [] + value: [ ] "400": description: Bad Request headers: @@ -8510,7 +8070,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /payment-sessions: post: tags: @@ -8837,7 +8397,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /itineraries: get: tags: @@ -9823,7 +9383,7 @@ paths: value: "11.95" currency: USD No itineraries: - value: [] + value: [ ] "400": description: Bad Request headers: @@ -10008,7 +9568,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] post: tags: - Bookings @@ -10481,7 +10041,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /itineraries/{itinerary_id}: get: tags: @@ -11683,7 +11243,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] put: tags: - Bookings @@ -11808,7 +11368,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "204": description: No Content - Held booking has successfully resumed. headers: @@ -11850,7 +11410,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "400": description: Bad Request headers: @@ -12079,7 +11639,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] delete: tags: - Manage Booking @@ -12207,7 +11767,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "204": description: No Content - Booking has successfully canceled. headers: @@ -12249,7 +11809,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "400": description: Bad Request headers: @@ -12484,7 +12044,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /itineraries/{itinerary_id}/invoice: get: tags: @@ -12865,7 +12425,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /itineraries/{itinerary_id}/payment-sessions: put: tags: @@ -13244,7 +12804,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /itineraries/{itinerary_id}/rooms/{room_id}: put: tags: @@ -13395,7 +12955,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "204": description: No Content - Booking has successfully changed. headers: @@ -13437,7 +12997,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "400": description: Bad Request headers: @@ -13666,7 +13226,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] delete: tags: - Manage Booking @@ -13802,7 +13362,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "204": description: No Content - Booking has successfully canceled. headers: @@ -13844,7 +13404,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "400": description: Bad Request headers: @@ -14073,7 +13633,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /itineraries/{itinerary_id}/rooms/{room_id}/pricing: put: tags: @@ -14234,7 +13794,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "204": description: No Content - Booking has successfully changed. headers: @@ -14276,7 +13836,7 @@ paths: type: string Region: $ref: '#/components/headers/Region' - content: {} + content: { } "400": description: Bad Request headers: @@ -14570,11 +14130,3873 @@ paths: schema: type: number Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + description: "Optional header that indicates the state (inactive, active)\ + \ of minute capacity reduction triggered once all daily capacity has\ + \ been used." + schema: + type: string + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/amenities: + get: + tags: + - Content + summary: Amenities Reference + description: | + Returns a complete collection of amenities available in the Rapid API. + operationId: getAmenitiesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/AmenityReference' + example: + "1073744371": + id: 1073744371 + name: Air hockey + has_value: false + "1073745340": + id: 1073745340 + name: Single-level property + has_value: false + "1073744373": + id: 1073744373 + name: Garage + has_value: false + "1073743392": + id: 1073743392 + name: Free WiFi (limited) time + has_value: true + "2593": + id: 2593 + name: Number of meeting rooms - + has_value: true + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/categories: + get: + tags: + - Content + summary: Categories Reference + description: | + Returns a complete collection of categories available in the Rapid API. + operationId: getCategoriesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/CategoryProperty' + example: + "44": + id: 44 + name: Mobile home + "24": + id: 24 + name: Campsite + "12": + id: 12 + name: Hostel/Backpacker accommodation + "21": + id: 21 + name: Tree house property + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /chains: + get: + tags: + - Content + summary: Chain Reference ***DEPRECATED*** + description: | + ***DEPRECATED*** Please use `/references/chains` +
Returns a complete collection of chains recognized by the Rapid API. +
Chains represent a parent company which can have multiple brands associated with it. A brand can only be + associated with one chain. For example, Hilton Worldwide is a chain that has multiple associated brands + including DoubleTree, Hampton Inn and Embassy Suites. +
The response is a JSON map where the key is the chain ID and the value is a chain object. Each chain object + also contains a map of its related brands. +
Note that the set of chain IDs and brand IDs are totally independent of one another. It is possible for a + chain and a brand to both use the same number as their ID, but this is just a coincidence that holds no meaning. +
Chain and brand names are provided in English only. + operationId: getChainReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/Chain' + example: + "-5": + id: -5 + name: Hilton Worldwide + brands: + "33": + id: "33" + name: Doubletree + "2146": + id: "2146" + name: Conrad + "358": + id: "358" + name: Hampton Inn + "38": + id: "38" + name: Embassy Suites + "4615": + id: "4615" + name: Tapestry Collection by Hilton + "4138": + id: "4138" + name: Tru by Hilton + "2059": + id: "2059" + name: Hilton Garden Inn + "2608": + id: "2608" + name: Home2 Suites by Hilton + "2513": + id: "2513" + name: Hilton Grand Vacations + "2194": + id: "2194" + name: Waldorf Astoria + "54": + id: "54" + name: Homewood Suites + "55": + id: "55" + name: Hilton Hotels + "2199": + id: "2199" + name: Hilton International + "3000": + id: "3000" + name: Curio Collection + "2102": + id: "2102" + name: MGM + brands: + "2102": + id: "2102" + name: MGM + "4445": + id: "4445" + name: Studios 2 Let + brands: + "4498": + id: "4498" + name: Studios 2 Let + "6325": + id: "6325" + name: Isla Bonita + brands: + "6399": + id: "6399" + name: Isla Bonita + "6200": + id: "6200" + name: Urban Dream Hotels + brands: + "6325": + id: "6325" + name: Urban Dream Hotels + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/chains: + get: + tags: + - Content + summary: Chains Reference + description: | + Returns a complete collection of chains recognized by the Rapid API. +
Chains represent a parent company which can have multiple brands associated with it. A brand can only be + associated with one chain. For example, Hilton Worldwide is a chain that has multiple associated brands + including DoubleTree, Hampton Inn and Embassy Suites. +
The response is a JSON map where the key is the chain ID and the value is a chain object. Each chain object + also contains a map of its related brands. +
Note that the set of chain IDs and brand IDs are totally independent of one another. It is possible for a + chain and a brand to both use the same number as their ID, but this is just a coincidence that holds no meaning. +
Chain and brand names are provided in English only. + operationId: getChainsReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/Chain' + example: + "-5": + id: -5 + name: Hilton Worldwide + brands: + "33": + id: "33" + name: Doubletree + "2146": + id: "2146" + name: Conrad + "358": + id: "358" + name: Hampton Inn + "38": + id: "38" + name: Embassy Suites + "4615": + id: "4615" + name: Tapestry Collection by Hilton + "4138": + id: "4138" + name: Tru by Hilton + "2059": + id: "2059" + name: Hilton Garden Inn + "2608": + id: "2608" + name: Home2 Suites by Hilton + "2513": + id: "2513" + name: Hilton Grand Vacations + "2194": + id: "2194" + name: Waldorf Astoria + "54": + id: "54" + name: Homewood Suites + "55": + id: "55" + name: Hilton Hotels + "2199": + id: "2199" + name: Hilton International + "3000": + id: "3000" + name: Curio Collection + "2102": + id: "2102" + name: MGM + brands: + "2102": + id: "2102" + name: MGM + "4445": + id: "4445" + name: Studios 2 Let + brands: + "4498": + id: "4498" + name: Studios 2 Let + "6325": + id: "6325" + name: Isla Bonita + brands: + "6399": + id: "6399" + name: Isla Bonita + "6200": + id: "6200" + name: Urban Dream Hotels + brands: + "6325": + id: "6325" + name: Urban Dream Hotels + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/general-attributes: + get: + tags: + - Content + summary: General Attributes Reference + description: | + Returns a complete collection of general attributes available in the Rapid API. + operationId: getGeneralAttributesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/AttributeReference' + example: + "2545": + id: 2545 + name: No cribs (infant beds) available + has_value: false + "2544": + id: 2544 + name: No rollaway/extra beds available + has_value: false + "2940": + id: 2940 + name: Minimum guest age is + has_value: true + "2003": + id: 2003 + name: Clothing optional (nudity permitted in public areas) + has_value: false + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/images: + get: + tags: + - Content + summary: Images Reference + description: | + Returns a complete collection of images available in the Rapid API. + operationId: getImagesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/ImageReference' + example: + "10001": + id: 10001 + name: Lobby + "91003": + id: 91003 + name: Front of property - evening/night + "56011": + id: 56011 + name: Raised toilet seat + "22003": + id: 22003 + name: Room service - dining + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/onsite-payment-types: + get: + tags: + - Content + summary: Onsite Payment Types Reference + description: | + Returns a complete collection of onsite payment types available in the Rapid API. + operationId: getOnsitePaymentTypesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/PaymentType' + example: + "190": + id: 190 + name: Cash not accepted + "171": + id: 171 + name: American Express + "407": + id: 407 + name: Cash + "1073742461": + id: 1073742461 + name: Debit cards + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/pet-attributes: + get: + tags: + - Content + summary: Pet Attributes Reference + description: | + Returns a complete collection of pet attributes available in the Rapid API. + operationId: getPetAttributesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/AttributeReference' + example: + "1073744793": + id: 1073744793 + name: Only cats are allowed + has_value: false + "5059": + id: 5059 + name: Service animals are exempt from fees/restrictions + has_value: false + "2644": + id: 2644 + name: Pet max weight (per pet) in kg is + has_value: true + "51": + id: 51 + name: Pets allowed + has_value: false + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/rate-amenities: + get: + tags: + - Content + summary: Rate Amenities Reference + description: | + Returns a complete collection of rate amenities available in the Rapid API. + operationId: getRateAmenitiesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/AmenityReference' + example: + "1073743286": + id: 1073743286 + name: Free massage included + has_value: false + "1073743391": + id: 1073743391 + name: Chain loyalty rate + has_value: false + "2098": + id: 2098 + name: Free breakfast + has_value: false + "2235": + id: 2235 + name: Casino credit + has_value: false + "2108": + id: 2108 + name: Food/beverage credit + has_value: false + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/room-amenities: + get: + tags: + - Content + summary: Room Amenities Reference + description: | + Returns a complete collection of roomo amenities available in the Rapid API. + operationId: getRoomAmenitiesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/AmenityReference' + example: + "4296": + id: 4296 + name: Furnished balcony or patio + has_value: false + "1073743396": + id: 1073743396 + name: Free WiFi (limited) time + has_value: true + "1073744315": + id: 1073744315 + name: Data speed + has_value: true + "1073744558": + id: 1073744558 + name: All-in-one washer and dryer + has_value: false + "1073744439": + id: 1073744439 + name: Lobster/crab pot + has_value: false + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/room-images: + get: + tags: + - Content + summary: Room Images Reference + description: | + Returns a complete collection of room images available in the Rapid API. + operationId: getRoomImagesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/ImageReference' + example: + "71012": + id: 71012 + name: Pet-friendly + "60008": + id: 60008 + name: Archery + "30012": + id: 56011 + name: Pool waterfall + "60021": + id: 60021 + name: Kayaking + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/room-views: + get: + tags: + - Content + summary: Room Views Reference + description: | + Returns a complete collection of room views available in the Rapid API. + operationId: getRoomViewsReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/View' + example: + "4219": + id: 4219 + name: Mountain view + "1073742607": + id: 1073742607 + name: Harbor view + "1073742612": + id: 1073742612 + name: Partial lake view + "4134": + id: 4134 + name: City view + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/spoken-languages: + get: + tags: + - Content + summary: Spoken Languages Reference + description: | + Returns a complete collection of spoken languages available in the Rapid API. + operationId: getSpokenLanguagesReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/SpokenLanguage' + example: + el: + id: el + name: Greek + en: + id: en + name: English + fr: + id: fr + name: French + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: too_many_requests + message: You have reached your capacity for this type of request. + "500": + description: Unknown Internal Error + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: unknown_internal_error + message: An internal server error has occurred. + "503": + description: Service Unavailable + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: service_unavailable + message: This service is currently unavailable. + security: + - rapidAuth: [ ] + /references/statistics: + get: + tags: + - Content + summary: Statistics Reference + description: | + Returns a complete collection of statistics available in the Rapid API. + operationId: getStatisticsReference + parameters: + - name: Accept + in: header + description: | + Specifies the response format that the client would like to receive back. This must be `application/json`. + required: true + schema: + type: string + example: application/json + - name: Accept-Encoding + in: header + description: | + Specifies the response encoding that the client would like to receive back. This must be `gzip`. + required: true + schema: + type: string + example: gzip + - name: User-Agent + in: header + description: | + The `User-Agent` header string from the customer's request, as captured by your integration. If you are + building an application then the `User-Agent` value should be `{app name}/{app version}`. + required: true + schema: + type: string + example: TravelNow/3.30.112 + - name: Customer-Session-Id + in: header + description: | + Insert your own unique value for each user session, beginning with the first API call. Continue to pass the + same value for each subsequent API call during the user's session, using a new value for every new customer + session.
+ Including this value greatly eases EPS's internal debugging process for issues with partner requests, as it + explicitly links together request paths for individual user's session. + schema: + type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK + - name: billing_terms + in: query + description: | + This parameter is to specify the terms of how a resulting booking should be billed. If this field is + needed, the value for this will be provided to you separately. + schema: + type: string + - name: partner_point_of_sale + in: query + description: | + This parameter is to specify what point of sale is being used to shop and book. If this field is needed, + the value for this will be provided to you separately. + schema: + type: string + - name: payment_terms + in: query + description: | + This parameter is to specify what terms should be used when being paid for a resulting booking. If this + field is needed, the value for this will be provided to you separately. + schema: + type: string + - name: platform_name + in: query + description: | + This parameter is to specify what platform is being used to shop and book. If this field is needed, the + value for this will be provided to you separately. + schema: + type: string + responses: + "200": + description: OK + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + type: object + additionalProperties: + $ref: '#/components/schemas/StatisticReference' + example: + "1073743380": + id: 1073743380 + name: Max occupancy - + has_value: true + "2515": + id: 2515 + name: Year Built - + has_value: true + "55": + id: 55 + name: Number of buildings/towers - + has_value: true + "1073743538": + id: 1073743538 + name: Property floor area (square meters) - + has_value: true + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring + "401": + description: Unauthorized + headers: + Region: + $ref: '#/components/headers/Region' + WWW-Authenticate: + description: Provides an example of the Authorization header. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthenticated + message: Data required to authenticate your request is missing or + inaccurate. Ensure that your request follows the guidelines in our + documentation. + fields: + - name: apikey + type: header + value: jaj3982k239dka328e + - name: signature + type: header + value: 129d75332614a5bdbe0c7eb540e95a65f9d85a5b53dabb38d19b37fad6312a2bd25c12ee5a82831d55112087e1b + - name: timestamp + type: header + value: 198284729 + - name: servertimestamp + type: server + value: 198284729 + "403": + description: Forbidden + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: request_unauthorized + message: Your request could not be authorized. + "426": + description: Upgrade Required + headers: + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: upgrade_required + message: This service requires the use of TLS. + "429": + description: Too Many Requests + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -14609,23 +18031,15 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] - /chains: + - rapidAuth: [ ] + /references/themes: get: tags: - Content - summary: Chain Reference + summary: Themes Reference description: | - Returns a complete collection of chains recognized by the Rapid API. -
Chains represent a parent company which can have multiple brands associated with it. A brand can only be - associated with one chain. For example, Hilton Worldwide is a chain that has multiple associated brands - including DoubleTree, Hampton Inn and Embassy Suites. -
The response is a JSON map where the key is the chain ID and the value is a chain object. Each chain object - also contains a map of its related brands. -
Note that the set of chain IDs and brand IDs are totally independent of one another. It is possible for a - chain and a brand to both use the same number as their ID, but this is just a coincidence that holds no meaning. -
Chain and brand names are provided in English only. - operationId: getChainReference + Returns a complete collection of themes available in the Rapid API. + operationId: getThemesReference parameters: - name: Accept in: header @@ -14662,6 +18076,22 @@ paths: explicitly links together request paths for individual user's session. schema: type: string + - name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK - name: billing_terms in: query description: | @@ -14695,41 +18125,19 @@ paths: description: OK headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -14737,82 +18145,57 @@ paths: schema: type: object additionalProperties: - $ref: '#/components/schemas/Chain' + $ref: '#/components/schemas/Theme' example: - "-5": - id: -5 - name: Hilton Worldwide - brands: - "33": - id: "33" - name: Doubletree - "2146": - id: "2146" - name: Conrad - "358": - id: "358" - name: Hampton Inn - "38": - id: "38" - name: Embassy Suites - "4615": - id: "4615" - name: Tapestry Collection by Hilton - "4138": - id: "4138" - name: Tru by Hilton - "2059": - id: "2059" - name: Hilton Garden Inn - "2608": - id: "2608" - name: Home2 Suites by Hilton - "2513": - id: "2513" - name: Hilton Grand Vacations - "2194": - id: "2194" - name: Waldorf Astoria - "54": - id: "54" - name: Homewood Suites - "55": - id: "55" - name: Hilton Hotels - "2199": - id: "2199" - name: Hilton International - "3000": - id: "3000" - name: Curio Collection - "2102": - id: "2102" - name: MGM - brands: - "2102": - id: "2102" - name: MGM - "4445": - id: "4445" - name: Studios 2 Let - brands: - "4498": - id: "4498" - name: Studios 2 Let - "6325": - id: "6325" - name: Isla Bonita - brands: - "6399": - id: "6399" - name: Isla Bonita - "6200": - id: "6200" - name: Urban Dream Hotels - brands: - "6325": - id: "6325" - name: Urban Dream Hotels + "5020": + id: 5020 + name: Winery property + "5001": + id: 5001 + name: Hot springs property + "1073744362": + id: 1073744362 + name: Romantic + "2332": + id: 2332 + name: Eco-certified property + "400": + description: Invalid Input + headers: + Rate-Limit-Day: + $ref: '#/components/headers/Rate-Limit-Day' + Rate-Limit-Day-Remaining: + $ref: '#/components/headers/Rate-Limit-Day-Remaining' + Rate-Limit-Day-Reset: + $ref: '#/components/headers/Rate-Limit-Day-Reset' + Rate-Limit-Minute: + $ref: '#/components/headers/Rate-Limit-Minute' + Rate-Limit-Minute-Remaining: + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' + Rate-Limit-Minute-Reset: + $ref: '#/components/headers/Rate-Limit-Minute-Reset' + Rate-Limit-Reduction-Status: + $ref: '#/components/headers/Rate-Limit-Reduction-Status' + Region: + $ref: '#/components/headers/Region' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + example: + type: invalid_input + message: "An invalid request was sent in, please check the nested\ + \ errors for details." + errors: + - type: language.required + message: "A language is required. Supported languages are: [ar-SA,\ + \ cs-CZ, da-DK, de-DE, el-GR, en-US, es-ES, es-MX, fi-FI, fr-CA,\ + \ fr-FR, hr-HR, hu-HU, id-ID, is-IS, it-IT, ja-JP, lt-LT, ko-KR,\ + \ ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, sv-SE,\ + \ th-TH, tr-TR, uk-UA, vi-VN, zh-CN, zh-TW]" + fields: + - name: language + type: querystring "401": description: Unauthorized headers: @@ -14872,41 +18255,19 @@ paths: description: Too Many Requests headers: Rate-Limit-Day: - description: Reserved for future use. Optional header for request capacity - per day. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day' Rate-Limit-Day-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the daily time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Remaining' Rate-Limit-Day-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the daily capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Day-Reset' Rate-Limit-Minute: - description: Reserved for future use. Optional header for request capacity - per minute. - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute' Rate-Limit-Minute-Remaining: - description: "Optional header for the remaining capacity, as a percentage,\ - \ for the per minute time window." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Remaining' Rate-Limit-Minute-Reset: - description: "Optional header for the timestamp, as the number of milliseconds\ - \ since the Unix Epoch, when the per minute capacity resets." - schema: - type: number + $ref: '#/components/headers/Rate-Limit-Minute-Reset' Rate-Limit-Reduction-Status: - description: "Optional header that indicates the state (inactive, active)\ - \ of minute capacity reduction triggered once all daily capacity has\ - \ been used." - schema: - type: string + $ref: '#/components/headers/Rate-Limit-Reduction-Status' Region: $ref: '#/components/headers/Region' content: @@ -14941,7 +18302,7 @@ paths: type: service_unavailable message: This service is currently unavailable. security: - - rapidAuth: [] + - rapidAuth: [ ] /notifications: get: tags: @@ -15015,7 +18376,7 @@ paths: message: An agent canceled one or more rooms on this itinerary. affiliate_reference_id: "" security: - - rapidAuth: [] + - rapidAuth: [ ] post: tags: - Notifications @@ -15065,7 +18426,7 @@ paths: headers: Region: $ref: '#/components/headers/Region' - content: {} + content: { } "400": description: Bad Request headers: @@ -15088,7 +18449,7 @@ paths: - name: event_type type: path security: - - rapidAuth: [] + - rapidAuth: [ ] components: schemas: PropertyContent: @@ -17984,6 +21345,58 @@ components: $ref: '#/components/schemas/PhoneRequest' address: $ref: '#/components/schemas/BillingContactRequestAddress' + AmenityReference: + type: object + properties: + id: + type: string + description: Amenity id. + name: + type: string + description: Amenity name. + has_value: + type: boolean + description: Indicates whether an amenity will have an associated numeric + value. + description: An individual amenity reference. + AttributeReference: + type: object + properties: + id: + type: string + description: The attribute definition ID for this attribute. + name: + type: string + description: Attribute name. + has_value: + type: boolean + description: Indicates whether an attribute will have an associated numeric + value. + description: An individual attribute reference. + ImageReference: + type: object + properties: + id: + type: string + description: Image Id + name: + type: string + description: Image name + description: An individual image reference. + StatisticReference: + type: object + properties: + id: + type: string + description: The statistic definition ID for this statistic. + name: + type: string + description: Statistic name. + has_value: + type: boolean + description: Indicates whether a statistic will have an associated numeric + value. + description: An individual statistic reference. Notification: type: object properties: @@ -18326,6 +21739,8 @@ components: type: array description: An array of traders. items: + required: + - contact_message type: object properties: name: @@ -18507,7 +21922,73 @@ components: schema: type: string example: 5.5.5.5 + Language: + name: language + in: query + description: | + Desired language for the response as a subset of BCP47 format that only uses hyphenated pairs of two-digit + language and country codes. Use only ISO 639-1 alpha-2 language codes and ISO 3166-1 alpha-2 country codes. +

Reference: + * [W3 Language Tags](https://www.w3.org/International/articles/language-tags/) + * [Language Options](https://developers.expediagroup.com/docs/rapid/resources/reference/language-options) + required: true + schema: + type: string + examples: + English: + value: en-US + Cantonese: + value: zh-HK headers: + Rate-Limit-Day: + description: Reserved for future use. Optional header for request capacity per + day. + style: simple + explode: false + schema: + type: number + Rate-Limit-Day-Remaining: + description: "Optional header for the remaining capacity, as a percentage, for\ + \ the daily time window." + style: simple + explode: false + schema: + type: number + Rate-Limit-Day-Reset: + description: "Optional header for the timestamp, as the number of milliseconds\ + \ since the Unix Epoch, when the daily capacity resets." + style: simple + explode: false + schema: + type: number + Rate-Limit-Minute: + description: Reserved for future use. Optional header for request capacity per + minute. + style: simple + explode: false + schema: + type: number + Rate-Limit-Minute-Remaining: + description: "Optional header for the remaining capacity, as a percentage, for\ + \ the per minute time window." + style: simple + explode: false + schema: + type: number + Rate-Limit-Minute-Reset: + description: "Optional header for the timestamp, as the number of milliseconds\ + \ since the Unix Epoch, when the per minute capacity resets." + style: simple + explode: false + schema: + type: number + Rate-Limit-Reduction-Status: + description: "Optional header that indicates the state (inactive, active) of\ + \ minute capacity reduction triggered once all daily capacity has been used." + style: simple + explode: false + schema: + type: string Region: description: Optional header that provides information about where the request was processed. @@ -18523,4 +22004,4 @@ components: \ authentication](https://developers.expediagroup.com/docs/rapid/resources/reference/signature-authentication)\ \ page for full details." name: Authorization - in: header \ No newline at end of file + in: header