{"info":{"_postman_id":"ff14d90d-1eb7-48ec-94b9-098e0e45fce1","name":"SAAS Project Collection","description":"

A mock api for tracking games in my personal collection.

Author: Dee Brecke

Class: SDEV 372

Quarter: Fall 2023

Endpoints:

/videogames -- accesses video game records
/boardgames -- accesses board game records

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30297492","collectionId":"ff14d90d-1eb7-48ec-94b9-098e0e45fce1","publishedId":"2s9YRCXrPv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-10-23T22:39:48.000Z"},"item":[{"name":"All Board Games","id":"789c3096-2db7-45ff-9c1a-1e5ae2eac20a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/boardgames","description":"

Retrieves all board games in order of their id's.

Responses:
200 (OK) All games retrieved

\n","urlObject":{"protocol":"http","port":"8080","path":["boardgames"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"789c3096-2db7-45ff-9c1a-1e5ae2eac20a"},{"name":"Random Board Game","id":"681d05b6-ecbe-45e7-8cbf-bb32645eee67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/boardgames/random","description":"

Retrieves a board game using a randomly generated id. Running this request multiple times brings different results.

Responses:

200 (OK) Board Game retrieved

\n","urlObject":{"protocol":"http","port":"8080","path":["boardgames","random"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"681d05b6-ecbe-45e7-8cbf-bb32645eee67"},{"name":"Board Game by Id","id":"1c791a9f-829e-45fa-ba5a-5d0acd8ecef6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/boardgames/3","description":"

Returns the board game with the id entered into the path variable. It is currently set at 3 , but this number can be changed in the path to return a different game.

Responses:

200 (OK) board game found and returned
\n
404 (NOT FOUND) board game is not found
\n

\n","urlObject":{"protocol":"http","port":"8080","path":["boardgames","3"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c791a9f-829e-45fa-ba5a-5d0acd8ecef6"},{"name":"Add New Board Game","id":"1ea52a1d-2e07-455b-9e63-453baae6bb00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"category\": \"family\",\r\n \"name\": \"connect 4\",\r\n \"minPlayers\": \"2\",\r\n \"maxPlayers\": \"2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/boardgames","description":"

Adds a new board game object to the collection and assigns a unique id.

Example request body:

{

\"category\": \"family\",

\"name\": \"connect 4\",

\"minPlayers\": \"2\",

\"maxPlayers\": \"2\"

}

Responses:

201 (CREATED) Board game object successfully created
400 (BAD REQUEST) JSON not formatted correctly

*Note: leaving out a field does not return a 400 bad request status, it just puts a 0 (int fields) or null (string fields) in that field.

\n","urlObject":{"protocol":"http","port":"8080","path":["boardgames"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ea52a1d-2e07-455b-9e63-453baae6bb00"},{"name":"Update Board Game","id":"481d9842-9f31-4e09-ab30-547c5fa000a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":" {\r\n \"id\": \"1\",\r\n \"category\": \"logic\",\r\n \"name\": \"Catan\",\r\n \"minPlayers\": \"2\",\r\n \"maxPlayers\": \"4\"\r\n }\r\n","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/boardgames","description":"

Changes one or more fields of an existing board game object, as identified by id #.

Example body:

{

\"id\": \"1\"

\"category\": \"logic\",

\"name\": \"Catan\",

\"minPlayers\": 2,

\"maxPlayers\": 4

}

Responses:

200 (OK) Board game object successfully changed
404 (NOT FOUND) Id not valid, nothing was found to change
400 (BAD REQUEST) JSON not formatted correctly

*Note: leaving out a field does not return a 400 bad request status, it just puts a 0 (int fields) or null (string fields) in that field.

\n","urlObject":{"protocol":"http","port":"8080","path":["boardgames"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"481d9842-9f31-4e09-ab30-547c5fa000a8"},{"name":"Delete Board Game","id":"68af16ce-55e3-4963-a9cc-ada247a749c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/boardgames","description":"

Given an id #, board game object is removed.

Example body:

{

\"id\" : \"2\"

}

Responses:

204 (NO CONTENT) Game was successfully removed
404 (NOT FOUND) Id doesn't exist

\n","urlObject":{"protocol":"http","port":"8080","path":["boardgames"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"68af16ce-55e3-4963-a9cc-ada247a749c2"},{"name":"All Video Games","id":"800b5fe2-17bd-444c-a8c5-20fe91dea2cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/videogames","description":"

Retrieves all video games in order of their id's.
Responses:
200 (OK) All games retrieved

\n","urlObject":{"protocol":"http","port":"8080","path":["videogames"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"800b5fe2-17bd-444c-a8c5-20fe91dea2cd"},{"name":"Random Video Game","id":"61779e9c-0843-4f5e-bb25-731c2d76c541","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/videogames/random","description":"

Retrieves a video game object using a randomly generated id. Running this request multiple times brings different results.

Responses:

200 (OK) Video Game retrieved

\n","urlObject":{"protocol":"http","port":"8080","path":["videogames","random"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"61779e9c-0843-4f5e-bb25-731c2d76c541"},{"name":"Video Game by Id","id":"0b1830ba-a32d-4f46-90f3-918111faf983","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:8080/videogames/2","description":"

Returns the video game with the id entered into the path variable. It is currently set at 2 , but this number can be changed in the path to return a different game.

Responses:

200 (OK) video game found and returned
\n
404 (NOT FOUND) video game is not found
\n

\n","urlObject":{"protocol":"http","port":"8080","path":["videogames","2"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"0b1830ba-a32d-4f46-90f3-918111faf983"},{"name":"Add New Video Game","id":"2d94694d-9cc7-490e-8c82-5fd925311ed0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"consoleType\": \"Switch\",\r\n \"name\": \"Tetris 99\",\r\n \"multiplayer\": \"false\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/videogames","description":"

Adds a new board game object to the collection and assigns a unique id.

Example request body:

{

\"consoleType\": \"Switch\",

\"name\": \"MarioKart\",

\"multiplayer\": \"true\",

}

Responses:

201 (CREATED) video game object successfully created
\n
400 (BAD REQUEST) JSON not formatted correctly
\n

\n","urlObject":{"protocol":"http","port":"8080","path":["videogames"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d94694d-9cc7-490e-8c82-5fd925311ed0"},{"name":"Update Video Game","id":"b6cafa7c-808f-4ef4-b021-056e2e1ec085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"4\",\r\n \"consoleType\": \"Wii\",\r\n \"name\": \"MarioKart\",\r\n \"multiplayer\": \"true\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/videogames","description":"

Changes one or more fields of an existing video game object, as identified by id #.

Example body:

{

\"id\": \"2\",

\"consoleType\": \"Atari\",

\"name\": \"Pong\",

\"multiplayer\": \"true\"

}

Responses:

200 (OK) video game object successfully changed
\n
404 (NOT FOUND) Id not valid, nothing was found to change
\n
400 (BAD REQUEST) JSON not formatted correctly
\n

\n","urlObject":{"protocol":"http","port":"8080","path":["videogames"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"b6cafa7c-808f-4ef4-b021-056e2e1ec085"},{"name":"Delete Video Game","id":"4faed51f-e96f-4149-bff4-c511698b2107","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"3\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/videogames","description":"

Given an id #, video game object is removed.

Example body:

{

\"id\" : \"2\"

}

Responses:

204 (NO CONTENT) Game was successfully removed
404 (NOT FOUND) Id doesn't exist

\n","urlObject":{"protocol":"http","port":"8080","path":["videogames"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"4faed51f-e96f-4149-bff4-c511698b2107"}]}