Booking Manager API documentation

Bookings

Bookings for hotel rooms. There can be only one room for a given booking.

/bookings/{id} delete get

delete

Delete the booking. This can be only done if the booking is to happen in the future, bookings in the past are only deleted when the given room reserved is deleted.

get

Retrieve booking with the given database identifier.

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "id": 9,
  "fromDate": {
    "year": 2018,
    "month": "DECEMBER",
    "chronology": {
      "calendarType": "iso8601",
      "id": "ISO"
    },
    "dayOfMonth": 14,
    "dayOfWeek": "FRIDAY",
    "era": "CE",
    "dayOfYear": 348,
    "leapYear": false,
    "monthValue": 12
  },
  "toDate": {
    "year": 2018,
    "month": "DECEMBER",
    "chronology": {
      "calendarType": "iso8601",
      "id": "ISO"
    },
    "dayOfMonth": 20,
    "dayOfWeek": "THURSDAY",
    "era": "CE",
    "dayOfYear": 354,
    "leapYear": false,
    "monthValue": 12
  },
  "total": 1000,
  "usr": {
    "id": 2,
    "email": "alice.foobar@gmail.com",
    "firstName": "Alice",
    "surname": "Foobar",
    "passwordHash": "1000:7bcb0827b38e7491a533c7c3aa367f38f74a42bced95896f:cc52ab7b61050d1512352ef999d4e3a1dd52543480b01675",
    "administrator": false
  },
  "room": {
    "id": 6,
    "hotel": {
      "id": 5,
      "address": "Malaysia, Genting Islands",
      "name": "First World Hotel",
      "rooms": null
    },
    "number": 101,
    "description": "One large bed. Free Wi-Fi included.",
    "recommendedPrice": 1000,
    "image": "cafebabe",
    "imageMimeType": "image/jpeg",
    "type": "SINGLE_ROOM"
  },
  "_links": {
    "self": {
      "href": "http://localhost:8080/pa165/rest/bookings/9"
    },
    "bookings": {
      "href": "http://localhost:8080/pa165/rest/bookings/9/bookings"
    }
  }
}

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{
  "code": "ResourceNotFoundException",
  "message": "booking 90 not found"
}

/bookings/byUser get

get

Return all bookings for the given user. It is also possible to specify a date range to which the bookings should be reserved.

Request

Query Parameters

from: (date)
Date from which the query should start searching from.
Example:
```
2018-12-30
```
to: (date)
Date to which the query should stop searching to.
Example:
```
2019-02-10
```
user: required (integer)
Database identifier of the user we are interested in.

Users

All users of the system, including administrators.

/users get

get

Return all users registered in this system, including administrators.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "_embedded": {
    "users": [
      {
        "_links": {
          "self": {
            "href": "http://localhost:8080/pa165/rest/users/1"
          },
          "users": {
            "href": "http://localhost:8080/pa165/rest/users"
          }
        },
        "email": "john.doe@gmail.com",
        "firstName": "John",
        "id": 1,
        "surname": "Doe"
      },
      {
        "_links": {
          "self": {
            "href": "http://localhost:8080/pa165/rest/users/2"
          },
          "users": {
            "href": "http://localhost:8080/pa165/rest/users"
          }
        },
        "email": "alice.foobar@gmail.com",
        "firstName": "Alice",
        "id": 2,
        "surname": "Foobar"
      },
      {
        "_links": {
          "self": {
            "href": "http://localhost:8080/pa165/rest/users/3"
          },
          "users": {
            "href": "http://localhost:8080/pa165/rest/users"
          }
        },
        "email": "peter.gabriel@gene.sis",
        "firstName": "Peter",
        "id": 3,
        "surname": "Gabriel"
      },
      {
        "_links": {
          "self": {
            "href": "http://localhost:8080/pa165/rest/users/4"
          },
          "users": {
            "href": "http://localhost:8080/pa165/rest/users"
          }
        },
        "email": "booking.manager.admin@gmail.com",
        "firstName": "Admin",
        "id": 4,
        "surname": "Istrator"
      }
    ]
  },
  "_links": {
    "authenticate": {
      "href": "http://localhost:8080/pa165/rest/users/authenticate"
    },
    "self": {
      "href": "http://localhost:8080/pa165/rest/users"
    }
  }
}

/users/{id} get

get

Return user with the given id if such one exists.

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "_links": {
    "self": {
      "href": "http://localhost:8080/pa165/rest/users/1"
    },
    "users": {
      "href": "http://localhost:8080/pa165/rest/users"
    }
  },
  "email": "john.doe@gmail.com",
  "firstName": "John",
  "id": 1,
  "surname": "Doe"
}

/users/reserved get

get

List all the users which have at least one room reserved. It is also possible to specify date range in by which we wish to reduce the search.

Request

Query Parameters

from: (date)
Date from which the query should start searching from.
Example:
```
2018-12-30
```
to: (date)
Date to which the query should stop searching to.
Example:
```
2019-02-10
```

Hotels

/hotels get

get

Return all hotels present in the database.

Response

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "_embedded": {
    "hotels": [
      {
        "_links": {
          "rooms": {
            "href": "http://localhost:8080/pa165/rest/hotels/5/rooms"
          },
          "self": {
            "href": "http://localhost:8080/pa165/rest/hotels/5"
          }
        },
        "address": "Malaysia, Genting Islands",
        "id": 5,
        "name": "First World Hotel",
        "rooms": null
      },
      {
        "_links": {
          "rooms": {
            "href": "http://localhost:8080/pa165/rest/hotels/12/rooms"
          },
          "self": {
            "href": "http://localhost:8080/pa165/rest/hotels/12"
          }
        },
        "address": "Russia, Moscow",
        "id": 12,
        "name": "Izmailovo Hotel",
        "rooms": null
      },
      {
        "_links": {
          "rooms": {
            "href": "http://localhost:8080/pa165/rest/hotels/18/rooms"
          },
          "self": {
            "href": "http://localhost:8080/pa165/rest/hotels/18"
          }
        },
        "address": "Saudi Arabia, Mecca",
        "id": 18,
        "name": "Makkah Abraj Al Tayseer",
        "rooms": null
      },
      {
        "_links": {
          "rooms": {
            "href": "http://localhost:8080/pa165/rest/hotels/25/rooms"
          },
          "self": {
            "href": "http://localhost:8080/pa165/rest/hotels/25"
          }
        },
        "address": "USA, Las Vegas",
        "id": 25,
        "name": "City Center",
        "rooms": null
      },
      {
        "_links": {
          "rooms": {
            "href": "http://localhost:8080/pa165/rest/hotels/29/rooms"
          },
          "self": {
            "href": "http://localhost:8080/pa165/rest/hotels/29"
          }
        },
        "address": "USA, Las Vegas",
        "id": 29,
        "name": "Caesars Palace",
        "rooms": null
      }
    ]
  },
  "_links": {
    "create": {
      "href": "http://localhost:8080/pa165/rest/hotels/create"
    },
    "self": {
      "href": "http://localhost:8080/pa165/rest/hotels"
    }
  }
}

/hotels/{id} get delete put

get

Return hotel with the given id if such one exists.

delete

Delete hotel with the given id if such one exists.

put

Create a new hotel if the input data represent a valid hotel.

Return hotel with the given id if such one exists.

Request
Response

URI Parameters

id: required (string)

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "_links": {
    "rooms": {
      "href": "http://localhost:8080/pa165/rest/hotels/29/rooms"
    },
    "self": {
      "href": "http://localhost:8080/pa165/rest/hotels/29"
    }
  },
  "address": "USA, Las Vegas",
  "id": 29,
  "name": "Caesars Palace",
  "rooms": null
}

HTTP status code 404

Body

Media type: application/json

Type: any

Example:

{
  "code": "ResourceNotFoundException",
  "message": "hotel 1 not found"
}

/hotels/{id}/vacancy get

get

Returns a collection of Room for a given hotel (specified by the route parameter {id}).

Request

URI Parameters

id: required (string)

Query Parameters

from: (date)
Date from which the query should start searching from.
Example:
```
2018-12-30
```
to: (date)
Date to which the query should stop searching to.
Example:
```
2019-02-10
```

Rooms

All the rooms in the system. Room belongs exactly to one hotel.

Booking Manager API documentation version 1.0

Bookings

get /bookings

post /bookings/create

delete /bookings/{id}

URI Parameters

get /bookings/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

get /bookings/{id}/discount

URI Parameters

get /bookings/byUser

Query Parameters

Users

get /users

HTTP status code 200

Body

get /users/{id}

URI Parameters

HTTP status code 200

Body

get /users/email/{email}

URI Parameters

post /users/authenticate

get /users/reserved

Query Parameters

Hotels

get /hotels

HTTP status code 200

Body

get /hotels/{id}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

Body

delete /hotels/{id}

URI Parameters

put /hotels/{id}

URI Parameters

get /hotels/{id}/vacancy

URI Parameters

Query Parameters

get /hotels/{id}/rooms

URI Parameters

HTTP status code 200

Body

Rooms

get /rooms

get /rooms/{id}

URI Parameters

HTTP status code 200

Body

delete /rooms/{id}

URI Parameters

get /rooms/{id}/image

URI Parameters

post /rooms/create

get /rooms/number/{number}

URI Parameters