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

Class CheckRateApi

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

  • Constructor Details

    • CheckRateApi

      public CheckRateApi()

    • CheckRateApi

      @Autowired public CheckRateApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • checkRate

      public reactor.core.publisher.Mono<CheckRateRS> checkRate(String accept, String acceptEncoding, String contentType, CheckRateRQ body) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Check rate CheckRate is an _optional_ operation used to assess and valuate the rate before the actual booking. CheckRate returns the same information as the Availability response for a hotel rate with up-to-date price, along with additional information regarding the rate: rate breakdown, rate comments and upselling options. The CheckRate method can complement the booking process, as it returns additional information to the availability request. However, when the rateType value is 'RECHECK', the CheckRate method is mandatory. Besides the details for the rate, CheckRate has the option to also return information of higher rates of the same hotel being checked. This is called Upselling. Upselling returns additional room options, each with its own rate key, allowing you to upgrade the stay quality in room category and rate plan even after the CheckRate operation has been performed. Timeout for this operation is 15 seconds.

      200 - Successful operation.

      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.

      410 - error repeated

      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 CheckRate operation
      Returns:
      CheckRateRS
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • checkRateWithHttpInfo

      public reactor.core.publisher.Mono<org.springframework.http.ResponseEntity<CheckRateRS>> checkRateWithHttpInfo(String accept, String acceptEncoding, String contentType, CheckRateRQ body) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Check rate CheckRate is an _optional_ operation used to assess and valuate the rate before the actual booking. CheckRate returns the same information as the Availability response for a hotel rate with up-to-date price, along with additional information regarding the rate: rate breakdown, rate comments and upselling options. The CheckRate method can complement the booking process, as it returns additional information to the availability request. However, when the rateType value is 'RECHECK', the CheckRate method is mandatory. Besides the details for the rate, CheckRate has the option to also return information of higher rates of the same hotel being checked. This is called Upselling. Upselling returns additional room options, each with its own rate key, allowing you to upgrade the stay quality in room category and rate plan even after the CheckRate operation has been performed. Timeout for this operation is 15 seconds.

      200 - Successful operation.

      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.

      410 - error repeated

      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 CheckRate operation
      Returns:
      ResponseEntity<CheckRateRS>
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API

    • checkRateWithResponseSpec

      public org.springframework.web.reactive.function.client.WebClient.ResponseSpec checkRateWithResponseSpec(String accept, String acceptEncoding, String contentType, CheckRateRQ body) throws org.springframework.web.reactive.function.client.WebClientResponseException
      Check rate CheckRate is an _optional_ operation used to assess and valuate the rate before the actual booking. CheckRate returns the same information as the Availability response for a hotel rate with up-to-date price, along with additional information regarding the rate: rate breakdown, rate comments and upselling options. The CheckRate method can complement the booking process, as it returns additional information to the availability request. However, when the rateType value is 'RECHECK', the CheckRate method is mandatory. Besides the details for the rate, CheckRate has the option to also return information of higher rates of the same hotel being checked. This is called Upselling. Upselling returns additional room options, each with its own rate key, allowing you to upgrade the stay quality in room category and rate plan even after the CheckRate operation has been performed. Timeout for this operation is 15 seconds.

      200 - Successful operation.

      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.

      410 - error repeated

      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 CheckRate operation
      Returns:
      ResponseSpec
      Throws:
      org.springframework.web.reactive.function.client.WebClientResponseException - if an error occurs while attempting to invoke the API