Code Monkey home page Code Monkey logo

contosohotel's Introduction

Contoso Hotel Icon Contoso Hotel Demo in Python

Contoso Hotel Screenshot

General setup guidance

  1. Configure Environment Variable MSSQL_CONNECTION_STRING or supply a file named ./secrets-store/MSSQL_CONNECTION_STRING
  2. Run the app: gunicorn --bind=0.0.0.0 --workers=4 startup:app
  3. Populate Data:
    1. Either go to: http://localhost:8000/setup
    2. Or invoke the Rest API: Invoke-RestMethod -Uri 'http://localhost:8000/api/setup' -Method Post -Body '{ "drop_schema" : true, "create_schema": true, "populate_data" : true }' -ContentType 'application/json'

Docker based setup

  1. Build the Docker Image: docker build -t pycontosohotel:latest .
  2. Run the Docker Container:
    1. Using environment variable docker run -p 8000:8000 -e MSSQL_CONNECTION_STRING='DRIVER={ODBC Driver 18 for SQL Server};SERVER=MSSQLINSTANCENAME.database.windows.net;DATABASE=MSSQLDBNAME;UID=MSSQLUSERNAME;PWD=*******' pycontosohotel:latest
    2. Using volume mount
      1. Create a file MSSQL_CONNECTION_STRING with the connection string in the /path/to/secrets-store directory
      2. docker run -p 8000:8000 -v '/path/to/secrets-store:/app/secrets-store' pycontosohotel:latest
  3. Populate Data:
    1. Either go to: http://localhost:8000/setup
    2. Or invoke the Rest API: Invoke-RestMethod -Uri 'http://localhost:8000/api/setup' -Method Post -Body '{ "drop_schema" : true, "create_schema": true, "populate_data" : true }' -ContentType 'application/json'

API documentation

Get Hotels

Endpoint: GET /api/hotels

Get Parameter Type Default Value Description
hotelname string empty Optional Hotel Name to filter
exactMatch bool false Optional exactMatch (false uses like '%search%' )

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

[
  {
    "hotelId": 6,
    "hotelname": "Contoso Hotel Los Angeles",
    "pricePerNight": 350.0
  }
]

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/hotels'

Bash Curl

curl -X GET 'http://localhost:8000/api/hotels'

Get Visitors

Endpoint: GET /api/visitors

Get Parameter Type Default Value Description
name string empty Optional Name to filter (first or last name)
exactMatch bool false Optional exactMatch (false uses like '%search%' )

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

[
  {
    "firstname": "Frank",
    "lastname": "Green",
    "visitorId": 6
  }
]

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/visitors'

Bash Curl

curl -X GET 'http://localhost:8000/api/visitors'

Get Bookings

Endpoint: GET /api/bookings

Get Parameter Type Default Value Description
visitorId int empty Optional visitorId to filter
hotelId int empty Optional hotelId to filter
fromdate datetime (YYYY-MM-DD) empty Optionally filter for bookings that are after this date
untildate datetime (YYYY-MM-DD) empty Optionally filter for bookings that are before this date

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

[
  {
    "bookingId": 2,
    "checkin": "2024-07-05",
    "checkout": "2024-07-10",
    "hotelId": 2,
    "hotelname": "Contoso Hotel Paris",
    "visitorId": 2,
    "firstname": "Bob",
    "lastname": "Jones",
    "adults": 2,
    "kids": 0,
    "babies": 0,
    "rooms": 1,
    "price": 1000.0
  }
]

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/bookings'

Bash Curl

curl -X GET 'http://localhost:8000/api/bookings'

Get a single Hotel

Endpoint: GET /api/hotel?hotelId=<int>

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "hotelId": 6,
   "hotelname": "Contoso Hotel Los Angeles",
   "pricePerNight": 350.0
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/hotel?hotelId=2'

Bash Curl

curl -X GET 'http://localhost:8000/api/hotel?hotelId=2'

Get a single Visitor

Endpoint: GET /api/visitor?visitorId=<int>

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "firstname": "Frank",
   "lastname": "Green",
   "visitorId": 6
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/visitor?visitorId=2'

Bash Curl

curl -X GET 'http://localhost:8000/api/visitor?visitorId=2'

Get a single Booking

Endpoint: GET /api/booking?bookingId=<int>

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "bookingId": 2,
   "visitorId": 6,
   "hotelId": 2,
   "checkin": "2024-07-05",
   "checkout": "2024-07-10",
   "rooms": 1,
   "adults": 2,
   "kids": 0,
   "babies": 0,
   "price": 1000.0
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/booking?bookingId=2'

Bash Curl

curl -X GET 'http://localhost:8000/api/booking?bookingId=2'

Create Hotel

Endpoint: PUT /api/hotel

Request Body:

{
   "hotelname": "Contoso Hotel Los Angeles",
   "pricePerNight": 350.0
}

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "hotelId": 6,
   "hotelname": "Contoso Hotel Los Angeles",
   "pricePerNight": 350.0
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/hotel' -Method Put -ContentType 'application/json' -Body (@{
    hotelname = 'Contoso Hotel Los Angeles II'
    pricePerNight = 350.0
} | ConvertTo-Json)

Bash Curl

curl -X PUT 'http://localhost:8000/api/hotel' -H 'Content-Type: application/json' -d '{
    "hotelname": "Contoso Hotel Los Angeles II",
    "pricePerNight": 350.0
}'

Create Visitor

Endpoint: PUT /api/visitor

Request Body:

{
   "firstname": "Frank",
   "lastname": "Green"
}

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "visitorId": 6,
   "firstname": "Frank",
   "lastname": "Green"
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/visitor' -Method Put -ContentType 'application/json' -Body (@{
    firstname = 'Frank'
    lastname = 'Blue'
} | ConvertTo-Json)

Bash Curl

curl -X PUT 'http://localhost:8000/api/visitor' -H 'Content-Type: application/json' -d '{
    "firstname": "Frank",
    "lastname": "Blue"
}'

Create Booking

Endpoint: PUT /api/booking

Request Body:

{
   "visitorId": 6,
   "hotelId": 2,
   "checkin": "2024-07-05",
   "checkout": "2024-07-10",
   "adults": 2,
   "kids": 0,       // optional
   "babies": 0,     // optional
   "rooms": 1,      // optional
   "price": 1000.0  // optional
}

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "bookingId": 2,
   "visitorId": 6,
   "hotelId": 2,
   "checkin": "2024-07-05",
   "checkout": "2024-07-10",
   "rooms": 1,
   "adults": 2,
   "kids": 0,
   "babies": 0,
   "price": 1000.0
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/booking' -Method Put -ContentType 'application/json' -Body (@{
    visitorId = 6
    hotelId = 2
    checkin = '2025-07-05'
    checkout = '2025-07-10'
    adults = 2
    kids = 0
    babies = 0
    rooms = 1
    price = 1000.0
} | ConvertTo-Json)

Bash Curl

curl -X PUT 'http://localhost:8000/api/booking' -H 'Content-Type: application/json' -d '{
    "visitorId": 6,
    "hotelId": 2,
    "checkin": "2025-07-05",
    "checkout": "2025-07-10",
    "adults": 2,
    "kids": 0,
    "babies": 0,
    "rooms": 1,
    "price": 1000.0
}'

Update Hotel

Endpoint: POST /api/hotel

Request Body:

{
   "hotelId": 6,
   "hotelname": "Contoso Hotel Los Angeles",
   "pricePerNight": 350.0
}

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "hotelId": 6,
   "hotelname": "Contoso Hotel Los Angeles",
   "pricePerNight": 350.0
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/hotel' -Method Post -ContentType 'application/json' -Body (@{
    hotelId = 6
    hotelname = 'Contoso Hotel Los Angeles'
    pricePerNight = 350.0
} | ConvertTo-Json)

Bash Curl

curl -X POST 'http://localhost:8000/api/hotel' -H 'Content-Type: application/json' -d '{
    "hotelId": 6,
    "hotelname": "Contoso Hotel Los Angeles",
    "pricePerNight": 350.0
}'

Update Visitor

Endpoint: POST /api/visitor

Request Body:

{
   "visitorId": 6,
   "firstname": "Frank",
   "lastname": "Green"
}

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "visitorId": 6,
   "firstname": "Frank",
   "lastname": "Green"
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/visitor' -Method Post -ContentType 'application/json' -Body (@{
    visitorId = 6
    firstname = 'Frank'
    lastname = 'Green'
} | ConvertTo-Json)

Bash Curl

curl -X POST 'http://localhost:8000/api/visitor' -H 'Content-Type: application/json' -d '{
    "visitorId": 6,
    "firstname": "Frank",
    "lastname": "Green"
}'

Delete Hotel

Endpoint: DELETE /api/hotel?hotelId=<int>

Url Parameter Type Default Value Description
hotelId int empty Required id of the hotel

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "success": true,
   "deleted": true,  // indicates if deletion was necessary
   "hotelId": 6
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/hotel?hotelId=2' -Method Delete

Bash Curl

curl -X DELETE 'http://localhost:8000/api/hotel?hotelId=2'

Delete Visitor

Endpoint: DELETE /api/visitor?visitorId=<int>

Url Parameter Type Default Value Description
visitorId int empty Required id of the visitor

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "success": true,
   "deleted": true,  // indicates if deletion was necessary
   "visitorId": 6
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/visitor?visitorId=2' -Method Delete

Bash Curl

curl -X DELETE 'http://localhost:8000/api/visitor?visitorId=2'

Delete Booking

Endpoint: DELETE /api/booking?bookingId=<int>

Url Parameter Type Default Value Description
bookingId int empty Required id of the booking

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "success": true,
   "deleted": true,  // indicates if deletion was necessary
   "bookingId": 2
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/booking?bookingId=2' -Method Delete

Bash Curl

curl -X DELETE 'http://localhost:8000/api/booking?bookingId=2'

Setup the Database

Endpoint: POST /api/setup

Request Body:

{
   "drop_schema"  : false,
   "create_schema": true,
   "populate_data": true
}

Response Codes:

Code Description
200 Success
400 Bad Request (Invalid input data)
500 Internal Server Error (Server side processing error)

Example Response Body (Success - 200):

{
   "success": true,
   "drop_schema": false,
   "create_schema": { 
      "hotels": false,
      "visitors": false,
      "bookings": true 
   },
   "populate_data": { 
      "hotels": false,
      "visitors": true,
      "bookings": true
   }
}

Example Response Body (Failure - 400 or 500):

{ 
   "success" : false,
   "error" : "Some error message here"
}

Example Code

Click to expand

PowerShell

Invoke-RestMethod -Uri 'http://localhost:8000/api/setup' -Method Post -ContentType 'application/json' -Body (@{
    drop_schema = $true
    create_schema = $true
    populate_data = $true
} | ConvertTo-Json)

Bash Curl

curl -X POST 'http://localhost:8000/api/setup' -H 'Content-Type: application/json' -d '{
    "drop_schema": true,
    "create_schema": true,
    "populate_data": true
}'

contosohotel's People

Contributors

qxsch avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.