Show more

Use to navigate results, ENTER to select one, ESC to close

Type in any word to easily find the endpoint, property or group of operations you are looking for.

API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Hotel Booking System

Topics

  • Introduction
  • Authentication

Endpoints

  • Bookings
    • Get a booking by its id GET
    • Delete a booking DELETE
    • Get an invoice by booking id GET
    • Create a new booking POST
    • Retrieve a booking invoice as a PDF file, to download or print GET
  • Cities
    • Get a city by its id GET
    • Update a city PUT
    • Delete a city DELETE
    • Retrieves a list of cities based on the specified query parameters. GET
    • Create a new city POST
    • Returns TOP N most visited cities, N is 5 by default GET
    • Upload an image to a city POST
  • Guests
    • Retrieves a collection of unique recently visited hotels for a guest, presenting essential details. GET
    • Retrieves a collection of unique recently visited hotels for a the current authorized guest, presenting essential details. GET
  • Hotels
    • Get a hotel by its id GET
    • Update a hotel PUT
    • Delete a hotel DELETE
    • Retrieves a list of hotels based on the specified query parameters. GET
    • Create a new hotel POST
    • Upload an image to a hotel POST
    • Searches and filters hotels based on the specified criteria. GET
    • Retrieves the reviews for a specific hotel based on the specified query parameters. GET
    • Adds a review for a specific hotel. POST
    • Get a review by its id GET
    • Update a review PUT
    • Delete a review DELETE
    • Get hotel average rating GET
  • Login
    • Login a user POST
  • Register
    • Register a guest POST
  • Register admin
    • Register an admin POST
  • Rooms
    • Create a new discount POST
    • Get a discount by its id GET
    • Delete a discount DELETE
    • Retrieves a collection of featured deals based on the specified count. GET
    • Get a room by its id GET
    • Update a room PUT
    • Delete a room DELETE
    • Retrieves a list of rooms based on the specified query parameters. GET
    • Create a new room POST
    • Upload an image to a room POST
Powered by Bump.sh
API changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Hotel Booking System

Retrieves a collection of featured deals based on the specified count.

Ask AI
  • Open in ChatGPT
  • Open in Claude

  • View as Markdown
  • Copy as Markdown
GET /api/rooms/featured-deals

This endpoint allows clients to retrieve a curated list of featured deals. The response includes essential details for each deal, such as its hotel name, room type, star rating, discount percentage, and discounted price.

The number of featured deals to be retrieved can be specified using the deals parameter. If no count is provided, the default is set to 5.

Sample request:

GET /featured-deals?deals=3

Query parameters

  • deals integer(int32)

    The number of featured deals to retrieve. Default is 5.

    Default value is 5.

Responses

  • 200
    text/plain
    text/plain application/json text/json

    Returns the collection of featured deals.

    Hide response attributes Show response attributes object
    • hotelId string(uuid)
    • hotelName string | null
    • hotelImage object
      Hide hotelImage attributes Show hotelImage attributes object
      • imageUrl string | null
      • alternativeText string | null
      • Additional properties are NOT allowed
    • starRate integer(int32)
    • street string | null
    • latitude number(double)
    • longitude number(double)
    • roomId string(uuid)
    • roomNumber integer(int32)
    • roomType string

      Values are Standard, Luxury, Budget, or Boutique.

    • originalPrice number(double)
    • discountedPrice number(double)
    • discountPercentage number(double)
    • cityName string | null
    • country string | null
    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • hotelId string(uuid)
    • hotelName string | null
    • hotelImage object
      Hide hotelImage attributes Show hotelImage attributes object
      • imageUrl string | null
      • alternativeText string | null
      • Additional properties are NOT allowed
    • starRate integer(int32)
    • street string | null
    • latitude number(double)
    • longitude number(double)
    • roomId string(uuid)
    • roomNumber integer(int32)
    • roomType string

      Values are Standard, Luxury, Budget, or Boutique.

    • originalPrice number(double)
    • discountedPrice number(double)
    • discountPercentage number(double)
    • cityName string | null
    • country string | null
    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • hotelId string(uuid)
    • hotelName string | null
    • hotelImage object
      Hide hotelImage attributes Show hotelImage attributes object
      • imageUrl string | null
      • alternativeText string | null
      • Additional properties are NOT allowed
    • starRate integer(int32)
    • street string | null
    • latitude number(double)
    • longitude number(double)
    • roomId string(uuid)
    • roomNumber integer(int32)
    • roomType string

      Values are Standard, Luxury, Budget, or Boutique.

    • originalPrice number(double)
    • discountedPrice number(double)
    • discountPercentage number(double)
    • cityName string | null
    • country string | null
    • Additional properties are NOT allowed
GET /api/rooms/featured-deals
curl \
 -X GET http://api.example.com/api/rooms/featured-deals \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "hotelId": "string",
    "hotelName": "string",
    "hotelImage": {
      "imageUrl": "string",
      "alternativeText": "string"
    },
    "starRate": 42,
    "street": "string",
    "latitude": 42.0,
    "longitude": 42.0,
    "roomId": "string",
    "roomNumber": 42,
    "roomType": "Standard",
    "originalPrice": 42.0,
    "discountedPrice": 42.0,
    "discountPercentage": 42.0,
    "cityName": "string",
    "country": "string"
  }
]
Response examples (200)
[
  {
    "hotelId": "string",
    "hotelName": "string",
    "hotelImage": {
      "imageUrl": "string",
      "alternativeText": "string"
    },
    "starRate": 42,
    "street": "string",
    "latitude": 42.0,
    "longitude": 42.0,
    "roomId": "string",
    "roomNumber": 42,
    "roomType": "Standard",
    "originalPrice": 42.0,
    "discountedPrice": 42.0,
    "discountPercentage": 42.0,
    "cityName": "string",
    "country": "string"
  }
]