{"info":{"_postman_id":"ec32cd95-1d0b-4c2d-97a6-19b179c4134f","name":"ClubSeek API","description":"

Introduction

\n

ClubSeek is service that specializes in recommending bars based on user preferences of quality and occupancy.

\n

Overview

\n

Clients can use the API to view available Bars and get recommendations based on their personal preferences.

\n

Bar Owners can use the API to perform CRUD operations on Bars and view clients assigned to their bar

\n

Quick Start

\n

The application runs on localhost:8000 by default and the database runs on localhost:3306 (Disable any other MySQL Databases running locally to use this application).

\n

Install the Postman API collection, add AuthZ information from the README Document, and start adding Bars!

\n

Authentication

\n

API Endpoints open to clients are public and do not require authentication. Edit operations assigned to bar owners require basic authentication (/bars POST, PUT and /users GET)

\n

Error Codes

\n

200 OK: Request Successful
211 No Content: No Clients or Bars to Return
400 Bad Request: Inputted Information is Invalid (Context in Response Output)
401 Unauthorized: Authentication Credentials Missing or Invalid
503 Service Unavailable: API Client is unable to connect to Database

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Quick Start","slug":"quick-start"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"}],"owner":"16583544","collectionId":"ec32cd95-1d0b-4c2d-97a6-19b179c4134f","publishedId":"UyrGBZmX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-04-30T21:01:52.000Z"},"item":[{"name":"Add Bars","id":"d404900f-eb66-437d-a772-d8e03839b535","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"barName\": \"SuperEshaan\",\n \"wowFactor\": 30,\n \"capacity\": 100,\n \"currentTraffic\": 20,\n \"address\": \"30 Eshaan Drive Eoin, NJ 08841\"\n },\n {\n \"barName\": \"SuperAwais\",\n \"wowFactor\": 99,\n \"capacity\": 1000,\n \"currentTraffic\": 900,\n \"address\": \"84 Awais Drive Akku, NJ 08841\"\n }, \n {\n \"barName\": \"SuperAkku\",\n \"wowFactor\": 40,\n \"capacity\": 300,\n \"currentTraffic\": 241,\n \"address\": \"84 Akku Drive Awais, NJ 08841\"\n }, \n {\n \"barName\": \"SuperSidhu\",\n \"wowFactor\": 89,\n \"capacity\": 1000,\n \"currentTraffic\": 800,\n \"address\": \"84 Sidhu Drive Awais, NJ 08841\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"localhost:8000/bars","description":"
Schema
\n
{\n    'type': 'array',\n    \"minItems\": 1,\n    'items': {\n        'barName': {'type': 'string',  \"minLength\": 4, \"maxLength\": 30},\n        'wowFactor': {'type': 'integer', \"minimum\": 1, \"maximum\": 100},\n        'capacity': {'type': 'integer', \"minimum\": 1, \"maximum\": 1000},\n        'currentTraffic': {'type': 'integer', \"minimum\": 1, \"maximum\": 1000},\n        'address': {'type': 'string', \"minLength\": 4, \"maxLength\": 255},\n    },\n    'required': ['barName', 'wowFactor', 'capacity', 'currentTraffic']\n}\n\n
\n
Notes
\n\n
HTTP Responses
\n\n","urlObject":{"port":"8000","path":["bars"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"d404900f-eb66-437d-a772-d8e03839b535"},{"name":"View Bars","id":"fca290a7-035d-4b41-8383-f55529525577","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"localhost:8000/bars","description":"
Notes
\n\n
HTTP Responses
\n\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"ec32cd95-1d0b-4c2d-97a6-19b179c4134f","id":"ec32cd95-1d0b-4c2d-97a6-19b179c4134f","name":"ClubSeek API","type":"collection"}},"urlObject":{"port":"8000","path":["bars"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"fca290a7-035d-4b41-8383-f55529525577"},{"name":"Update Bars","id":"28903849-8f7b-4efb-beab-d56220601388","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"barName\": \"SuperEshaan\",\n \"address\": \"30 Eshaan Drive Eoin, NJ 08841\",\n \"wowFactorChange\": 31,\n \"capacityChange\": 100,\n \"currentTrafficChange\": 20\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8000/bars","description":"
Schema
\n
{\n    'type': 'object',\n    'properties': {\n        'barName': {'type': 'string',  \"minLength\": 4, \"maxLength\": 30},\n        'address': {'type': 'string', \"minLength\": 4, \"maxLength\": 255},\n        'wowFactorChange': {'type': 'integer', \"minimum\": 1, \"maximum\": 100},\n        'capacityChange': {'type': 'integer', \"minimum\": 1, \"maximum\": 1000},\n        'currentTrafficChange': {'type': 'integer', \"minimum\": 1, \"maximum\": 1000}\n    },\n    'required': ['barName', 'address']\n}\n\n
\n
Notes
\n
    \n
  • barName and address can't be updated once entered
      \n
    • Delete and re-add Bar to change these attributes
      • \n
    \n
    • \n
  • currentTraffic can't be greater than capacity
    • \n
\n
HTTP Responses
\n
    \n
  • 200 OK
      \n
    • Operation Successful
      • \n
    \n
    • \n
  • 400 Bad Request
      \n
    • A Bar has a currentTraffic that is greater than capacity
      • \n
    • There is no Bar with the following barName and address
      • \n
    \n
    • \n
  • 401 Unauthorized
      \n
    • Authentication Credentials Missing or Invalid
      • \n
    \n
    • \n
\n","urlObject":{"port":"8000","path":["bars"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"28903849-8f7b-4efb-beab-d56220601388"},{"name":"Delete Bar","id":"cb3dadfc-9c52-4058-93e5-3d9fed502c31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"barName\": \"SuperAkku\",\n \"address\": \"84 Akku Drive Awais, NJ 08841\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8000/bars","description":"
Schema
\n
{\n    'type': 'object',\n    'properties': {\n        'barName': {'type': 'string',  \"minLength\": 4, \"maxLength\": 30},\n        'address': {'type': 'string',  \"minLength\": 4, \"maxLength\": 255}\n    },\n    'required': ['barName', 'address']\n}\n\n
\n
Notes
\n
    \n
  • barName and address are primary keys and must be supplied to identify and delete a Bar
    • \n
\n
HTTP Responses
\n
    \n
  • 200 OK
      \n
    • Operation Successful
      • \n
    \n
    • \n
  • 400 Bad Request
      \n
    • There is no Bar with the following barName and address
      • \n
    \n
    • \n
  • 401 Unauthorized
      \n
    • Authentication Credentials Missing or Invalid
      • \n
    \n
    • \n
\n","urlObject":{"port":"8000","path":["bars"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb3dadfc-9c52-4058-93e5-3d9fed502c31"},{"name":"Bar Selection","id":"3bc9fa9d-7716-467d-ab3a-6097c1d32b02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Eshaan Mathur\",\n \"phoneNumber\": \"9072834045\",\n \"minWowFactor\": 20,\n \"maxTraffic\": 100,\n \"preference\": \"wowFactor\"\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8000/barSelection","description":"
Schema
\n
{\n    'type': 'object',\n    'properties': {\n        'name': {'type': 'string',  \"minLength\": 4, \"maxLength\": 30},\n        'phoneNumber': {'type': 'string' , \"minLength\": 10, \"maxLength\": 15},\n        'minWowFactor': {'type': 'integer', \"minimum\": 1, \"maximum\": 100},\n        'maxTraffic': {'type': 'integer', \"minimum\": 1, \"maximum\": 1000},\n        'preference': {'type': 'string'}\n    },\n    'required': ['name', 'phoneNumber']\n}\n\n
\n
Notes
\n
    \n
  • Once a Bar has been selected for a Client, their information and Bar assignment will be stored. You can view Users with the /users GET endpoint (AuthZ required)
      \n
    • name and phoneNumber are primary keys for the Client
      • \n
    • The Users Table is cleared every night. Only one request is allowed per client per night.
      • \n
    \n
    • \n
  • preference can be capacity or wowFactor. If the attribute is not defined it will default to capacity
    • \n
\n
HTTP Responses
\n
    \n
  • 200 OK
      \n
    • Operation Successful
      • \n
    \n
    • \n
  • 211 No Content:
      \n
    • No Bars Meet Minimum Requirements
      • \n
    \n
    • \n
  • 400 Bad Request
      \n
    • A Client already exists in the Users Table (Only One Request is allowed per Client per night)
      • \n
    \n
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"ec32cd95-1d0b-4c2d-97a6-19b179c4134f","id":"ec32cd95-1d0b-4c2d-97a6-19b179c4134f","name":"ClubSeek API","type":"collection"}},"urlObject":{"port":"8000","path":["barSelection"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"3bc9fa9d-7716-467d-ab3a-6097c1d32b02"},{"name":"View Users","id":"bed024d2-2946-4cc3-9c63-c400108ed891","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"localhost:8000/users","description":"
Notes
\n
    \n
  • Users are returned as an array of JSON Objects
    • \n
\n
HTTP Responses
\n
    \n
  • 200 OK
      \n
    • Operation Successful
      • \n
    \n
    • \n
  • 211 No Content
      \n
    • No Clients or Bars to Return
      • \n
    \n
    • \n
  • 401 Unauthorized
      \n
    • Authentication Credentials Missing or Invalid
      • \n
    \n
    • \n
\n","urlObject":{"port":"8000","path":["users"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"bed024d2-2946-4cc3-9c63-c400108ed891"},{"name":"Readiness Probe","id":"366bc7a9-2317-4bbf-b9a0-6dae9a2ce542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"localhost:8000/readiness","description":"
Notes
\n
    \n
  • Used to Check if API Client has connection with Database
    • \n
\n
HTTP Responses
\n
    \n
  • 200 OK
      \n
    • API Ready for Requests
      • \n
    \n
    • \n
  • 503 Service Unavailable
      \n
    • API Client is unable to connect to Database
      • \n
    \n
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]},"isInherited":true,"source":{"_postman_id":"ec32cd95-1d0b-4c2d-97a6-19b179c4134f","id":"ec32cd95-1d0b-4c2d-97a6-19b179c4134f","name":"ClubSeek API","type":"collection"}},"urlObject":{"port":"8000","path":["readiness"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"366bc7a9-2317-4bbf-b9a0-6dae9a2ce542"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"2bc8e9d5-7c87-42cd-a4ee-0b2745d8a582","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"23d895dc-e8c6-4b19-965f-98a14119668d","type":"text/javascript","exec":[""]}}]}