Package travel.wink.hotelbeds.booking.sdk.api

Class AvailabilityApi

java.lang.Object
travel.wink.hotelbeds.booking.sdk.api.AvailabilityApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-10-04T11:28:08.331690043+07:00[Asia/Bangkok]") public class AvailabilityApi extends Object

  • Constructor Details

    • AvailabilityApi

      public AvailabilityApi()

    • AvailabilityApi

      @Autowired public AvailabilityApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • availability

      public reactor.core.publisher.Mono<AvailabilityRS> availability(String accept, String acceptEncoding, String contentType, AvailabilityRQ body) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Hotel availability This method is used to request **room availability**. Some filters and special features can be applied before sending an availability request. A flexible date search allows customers to retrieve available rates for a specified number of days prior to and post check-in. The response generated is a list of hotels with the different room types, board types, and rates available for those hotels, but not only restricted to the dates selected. BookingAPI prices are final. Our rates include supplements and discounts and no additional price calculations are required. It can also return cancellation fees in the availability response, providing amounts and dates at the first step of the booking. Timeout for this operation is 5 seconds.

      200 - Successful operation. The hotel availability response contains all information necessary to confirm the booking or to recheck availability for a particular hotel. It is distributed in hotel nodes which contain the information about the hotel and the different rates with their room types and board types. If you are interested in reducing the weight of the XML or JSON response, the availability response is customizable in different profiles. Using this options, several nodes (and the description nodes as well) can be removed from the response.

      400 - **BAD REQUEST** - The server cannot or will not process the request due to an apparent client error. *INVALID_REQUEST* - The request is not compliant with the specified version of the API. The message body will contain more information *INVALID_DATA* - The JSON or XML syntax is correct, however some of the fields contain incorrect data. Please check the documentation for the allowed values and follow the message returned in order to fix this error. *ALLOTMENT EXCEEDED*

      401 - **UNAUTHORIZED** - Authentication has failed or has not been provided. * Authorization field missing * Request signature verification failed

      403 - **FORBIDDEN** - The credentials are correct and authorization was succesful, but access to this resource/operation is not allowed.

      406 - **NOT ACCEPTABLE** - The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

      415 - **UNSUPPORTED MEDIA TYPE** - Use the Content-Type header to set application/json and be sure the format of your payload matches the format

      429 - **Rate limit exceeded** - The user has sent too many requests in a given amount of time.

      500 - **INTERNAL SERVER ERROR** - An unexpected condition was encountered. Possible causes *SYSTEM_ERROR* - These are internal server errors, please send us these errors together with the complete logs (JSON or XML requests and responses) at [apitude@hotelbeds.com]() so that our team can review them. *PRODUCT_ERROR* - This type of error is produced due to product restrictions or due to other account set-up limitations. In all cases, the end result is that the booking cannot be confirmed. Here is a list of common product errors: * *Insufficient allotment*: This means that the user is trying to book a room which is no longer available. This may happen if the room was still available in the Availability stage but someone else has made a reservation for this room or rooms. * *Price has increased*: The price increase between booking steps has exceeded the allowed tolerance that was set. This is a setting to protect clients from booking a room with a higher price than expected. * *Contract is closed/Office or branch not active/Cannot find channel quotation*: There are problems related to the contract. * *Stop sales*: This means that the hotel is forbidding sales on the requested dates. * *Booking confirmation error XXX-YYYYYY*: A confirmation error occurred. Please try again later. * *Release violated* * *There's a stop sales for the date/s* *CONFIGURATION_ERROR* - This type of error is produced by configuration restrictions set-up at account level. Usually this results in the inability to perform an specific operation. Here is a list of common configuration errors: * *This apikey is not associated with a valid client*: This means that the provided apiKey belongs to an inactive client/agency. If you need information regarding the cause for this please contact our support team at [apitude@hotelbeds.com]().

      Parameters:
      accept - Response format.
      acceptEncoding - Defines type of encoding used on the data.
      contentType - Defines request format.
      body - Definition and examples of request body of Availability operation
      Returns:
      AvailabilityRS
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • availabilityWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<AvailabilityRS>> availabilityWithHttpInfo(String accept, String acceptEncoding, String contentType, AvailabilityRQ body) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Hotel availability This method is used to request **room availability**. Some filters and special features can be applied before sending an availability request. A flexible date search allows customers to retrieve available rates for a specified number of days prior to and post check-in. The response generated is a list of hotels with the different room types, board types, and rates available for those hotels, but not only restricted to the dates selected. BookingAPI prices are final. Our rates include supplements and discounts and no additional price calculations are required. It can also return cancellation fees in the availability response, providing amounts and dates at the first step of the booking. Timeout for this operation is 5 seconds.

      200 - Successful operation. The hotel availability response contains all information necessary to confirm the booking or to recheck availability for a particular hotel. It is distributed in hotel nodes which contain the information about the hotel and the different rates with their room types and board types. If you are interested in reducing the weight of the XML or JSON response, the availability response is customizable in different profiles. Using this options, several nodes (and the description nodes as well) can be removed from the response.

      400 - **BAD REQUEST** - The server cannot or will not process the request due to an apparent client error. *INVALID_REQUEST* - The request is not compliant with the specified version of the API. The message body will contain more information *INVALID_DATA* - The JSON or XML syntax is correct, however some of the fields contain incorrect data. Please check the documentation for the allowed values and follow the message returned in order to fix this error. *ALLOTMENT EXCEEDED*

      401 - **UNAUTHORIZED** - Authentication has failed or has not been provided. * Authorization field missing * Request signature verification failed

      403 - **FORBIDDEN** - The credentials are correct and authorization was succesful, but access to this resource/operation is not allowed.

      406 - **NOT ACCEPTABLE** - The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

      415 - **UNSUPPORTED MEDIA TYPE** - Use the Content-Type header to set application/json and be sure the format of your payload matches the format

      429 - **Rate limit exceeded** - The user has sent too many requests in a given amount of time.

      500 - **INTERNAL SERVER ERROR** - An unexpected condition was encountered. Possible causes *SYSTEM_ERROR* - These are internal server errors, please send us these errors together with the complete logs (JSON or XML requests and responses) at [apitude@hotelbeds.com]() so that our team can review them. *PRODUCT_ERROR* - This type of error is produced due to product restrictions or due to other account set-up limitations. In all cases, the end result is that the booking cannot be confirmed. Here is a list of common product errors: * *Insufficient allotment*: This means that the user is trying to book a room which is no longer available. This may happen if the room was still available in the Availability stage but someone else has made a reservation for this room or rooms. * *Price has increased*: The price increase between booking steps has exceeded the allowed tolerance that was set. This is a setting to protect clients from booking a room with a higher price than expected. * *Contract is closed/Office or branch not active/Cannot find channel quotation*: There are problems related to the contract. * *Stop sales*: This means that the hotel is forbidding sales on the requested dates. * *Booking confirmation error XXX-YYYYYY*: A confirmation error occurred. Please try again later. * *Release violated* * *There's a stop sales for the date/s* *CONFIGURATION_ERROR* - This type of error is produced by configuration restrictions set-up at account level. Usually this results in the inability to perform an specific operation. Here is a list of common configuration errors: * *This apikey is not associated with a valid client*: This means that the provided apiKey belongs to an inactive client/agency. If you need information regarding the cause for this please contact our support team at [apitude@hotelbeds.com]().

      Parameters:
      accept - Response format.
      acceptEncoding - Defines type of encoding used on the data.
      contentType - Defines request format.
      body - Definition and examples of request body of Availability operation
      Returns:
      ResponseEntity<AvailabilityRS>
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • availabilityWithResponseSpec

      public org.springframework.web.reactive.function.client.WebClient.ResponseSpec availabilityWithResponseSpec(String accept, String acceptEncoding, String contentType, AvailabilityRQ body) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Hotel availability This method is used to request **room availability**. Some filters and special features can be applied before sending an availability request. A flexible date search allows customers to retrieve available rates for a specified number of days prior to and post check-in. The response generated is a list of hotels with the different room types, board types, and rates available for those hotels, but not only restricted to the dates selected. BookingAPI prices are final. Our rates include supplements and discounts and no additional price calculations are required. It can also return cancellation fees in the availability response, providing amounts and dates at the first step of the booking. Timeout for this operation is 5 seconds.

      200 - Successful operation. The hotel availability response contains all information necessary to confirm the booking or to recheck availability for a particular hotel. It is distributed in hotel nodes which contain the information about the hotel and the different rates with their room types and board types. If you are interested in reducing the weight of the XML or JSON response, the availability response is customizable in different profiles. Using this options, several nodes (and the description nodes as well) can be removed from the response.

      400 - **BAD REQUEST** - The server cannot or will not process the request due to an apparent client error. *INVALID_REQUEST* - The request is not compliant with the specified version of the API. The message body will contain more information *INVALID_DATA* - The JSON or XML syntax is correct, however some of the fields contain incorrect data. Please check the documentation for the allowed values and follow the message returned in order to fix this error. *ALLOTMENT EXCEEDED*

      401 - **UNAUTHORIZED** - Authentication has failed or has not been provided. * Authorization field missing * Request signature verification failed

      403 - **FORBIDDEN** - The credentials are correct and authorization was succesful, but access to this resource/operation is not allowed.

      406 - **NOT ACCEPTABLE** - The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.

      415 - **UNSUPPORTED MEDIA TYPE** - Use the Content-Type header to set application/json and be sure the format of your payload matches the format

      429 - **Rate limit exceeded** - The user has sent too many requests in a given amount of time.

      500 - **INTERNAL SERVER ERROR** - An unexpected condition was encountered. Possible causes *SYSTEM_ERROR* - These are internal server errors, please send us these errors together with the complete logs (JSON or XML requests and responses) at [apitude@hotelbeds.com]() so that our team can review them. *PRODUCT_ERROR* - This type of error is produced due to product restrictions or due to other account set-up limitations. In all cases, the end result is that the booking cannot be confirmed. Here is a list of common product errors: * *Insufficient allotment*: This means that the user is trying to book a room which is no longer available. This may happen if the room was still available in the Availability stage but someone else has made a reservation for this room or rooms. * *Price has increased*: The price increase between booking steps has exceeded the allowed tolerance that was set. This is a setting to protect clients from booking a room with a higher price than expected. * *Contract is closed/Office or branch not active/Cannot find channel quotation*: There are problems related to the contract. * *Stop sales*: This means that the hotel is forbidding sales on the requested dates. * *Booking confirmation error XXX-YYYYYY*: A confirmation error occurred. Please try again later. * *Release violated* * *There's a stop sales for the date/s* *CONFIGURATION_ERROR* - This type of error is produced by configuration restrictions set-up at account level. Usually this results in the inability to perform an specific operation. Here is a list of common configuration errors: * *This apikey is not associated with a valid client*: This means that the provided apiKey belongs to an inactive client/agency. If you need information regarding the cause for this please contact our support team at [apitude@hotelbeds.com]().

      Parameters:
      accept - Response format.
      acceptEncoding - Defines type of encoding used on the data.
      contentType - Defines request format.
      body - Definition and examples of request body of Availability operation
      Returns:
      ResponseSpec
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API