{"info":{"_postman_id":"a96f1769-9d70-42b1-b828-8706211c7fad","name":"DiShelved","description":"

API for the DiShelved storage platform. DiShelved is an app that allows for the tracking of collectables, or other items, and their whereabouts. Users can organize their item collections by adding storage Locations and Containers. Items can be added to specific containers and each Item can be assigned any number of Categories by the User.

This API collection provides endpoints that can be used to manage Locations, Containers, Items, Categories, ItemCategories (specific to each item), as well as add new Users.

Getting Started

Follow the steps below:

Clone the DiShelved repository by using git clone in your terminal to copy it to your local machine.
\n
Open the project in and install the required with the following commands:
\n
dotnet add package Npgsql.EntityFrameworkCore.PostgreSQL --version 8.0
\n
dotnet add package Microsoft.EntityFrameworkCore.Design --version 8.0
\n
dotnet user-secrets init
\n
dotnet user-secrets set \"DiShelvedDbConnectionString\" \"Host=localhost;Port=5432;Username=postgres;Password=;Database=DiShelved\"
\n
Run dotnet ef database update in your terminal to populate your database.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting Started","slug":"getting-started"}],"owner":"36639418","collectionId":"a96f1769-9d70-42b1-b828-8706211c7fad","publishedId":"2sB2qfAzEy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-02T21:20:43.000Z"},"item":[{"name":"Categories","item":[{"name":"GET Single Category","id":"6396edee-e3b5-4a5a-a815-b377f06958e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Categories/:id","description":"

Retrieves details about a specific Category.

Categories possess their own unqiue IDs and are associated with a user by their userId. The user can create their own Categories with their own custom Names and Descriptions.

\n","urlObject":{"path":["Categories",":id"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"6396edee-e3b5-4a5a-a815-b377f06958e7"},{"name":"DELETE Category","id":"f7fab955-80ab-485b-bc48-fcca8df16d11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:5093/Categories/:id","description":"

Removes the specified Category from the database.

\n","urlObject":{"path":["Categories",":id"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"f7fab955-80ab-485b-bc48-fcca8df16d11"},{"name":"CREATE Category","id":"e7c4515e-43de-489b-a8bd-07d02d25f721","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"userId\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5093/Categories","description":"

This endpoint creates a new category and adds it to the database.

The Category is associated with a user by their userId and possesses a name and a description.

\n","urlObject":{"path":["Categories"],"host":["http://localhost:5093"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7c4515e-43de-489b-a8bd-07d02d25f721"},{"name":"GET Categories by UserId","id":"9aded99c-7133-463e-a062-4cf7ed37d60d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Categories/User/:userId","description":"

Retrieves all of the Categories for a specific User via their userId.

\n","urlObject":{"path":["Categories","User",":userId"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"userId"}]}},"response":[],"_postman_id":"9aded99c-7133-463e-a062-4cf7ed37d60d"},{"name":"UDATE Category","id":"19df5eb8-7199-4672-8ef3-2f05cbbf11d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"userId\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5093/Categories/:id","description":"

Updates a specific category. The name and description can be modified. The userId can technically be modified, however this is unlikely to happen in a live scenario. The Category ID should not be altered.

Manage Categories for Items.

Fields:

id: Unique identifier for the Category.
\n
name: The name of the Category, entered by the user.
\n
description: A description of the Category, entered by the user.
\n
userId: A unique identifier for the user.
\n

\n","_postman_id":"b7e101b6-f079-4ed9-a7a6-0d63328dd2fc"},{"name":"Containers","item":[{"name":"GET Single Container","id":"b626c385-0b18-4229-8743-7dc22b7108ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Containers/:id","description":"

Retrieves details about a specific Container.

Categories possess their own unqiue IDs and are associated with a user by their userId. The user can create their own Categories with their own custom Names and Descriptions.

Removes a Container from the Database.

Note: Only empty Containers can be deleted. Attempting to delete a Container with Items associated with it will return an error.

\n","urlObject":{"path":["Containers",":id"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"406f2a78-d4b8-457e-86fc-1f3ff42ad798"},{"name":"CREATE Container","id":"0638efd1-7937-431e-b1f9-b05e06c340f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"locationId\": 1,\r\n \"userId\": 1,\r\n \"image\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5093/Containers","description":"

Adds a new Container to the database.

The Container is associated with a user by their userId and with a location by its locationId possesses a name, description and an image link.

\n","urlObject":{"path":["Containers"],"host":["http://localhost:5093"],"query":[],"variable":[]}},"response":[],"_postman_id":"0638efd1-7937-431e-b1f9-b05e06c340f8"},{"name":"GET Containers by UserId","id":"3eb4fcd5-0121-4fd6-b968-8db68aaa264a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Containers/User/:userId","description":"

Retrieves all of the Containers for a specific User via their userId.

\n","urlObject":{"path":["Containers","User",":userId"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"userId"}]}},"response":[],"_postman_id":"3eb4fcd5-0121-4fd6-b968-8db68aaa264a"},{"name":"GET Containers by LocationId","id":"e596f0f1-09e8-4101-b21e-46eabd092f7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Containers/Location/:Iocationd","description":"

Retrieves all of the Containers for the Specified Location.

\n","urlObject":{"path":["Containers","Location",":Iocationd"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"Iocationd"}]}},"response":[],"_postman_id":"e596f0f1-09e8-4101-b21e-46eabd092f7d"},{"name":"UPDATE Container","id":"f7494bf4-39bb-4ffc-a86b-d18e150b8c56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 0,\r\n \"name\": \"string\",\r\n \"description\": \"string\",\r\n \"userId\": 0,\r\n \"locationId\": 1,\r\n \"image\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5093/Containers/:id","description":"

Updates a specific Container. The name, description, image and locationId can be modified. The userId can technically be modified, however this is unlikely to happen in a live scenario.

Manage Containers for Items.

Fields:

id: Unique identifier for the Container.
\n
name: The name of the Container, entered by the user.
\n
description: A description of the Container, entered by the user.
\n
locationId: The Id of the Location associated with this Container.
\n
userId: A unique identifier for the user.
\n
image: An image of the Container, entered by the user.
\n

\n","_postman_id":"de0b6d80-6431-4ba8-860e-547139bf7fe8"},{"name":"Items","item":[{"name":"GET Single Item","id":"3822781b-33ad-4d6b-a91d-0d66f1a5dfb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Items/:id","description":"

Retrieves details about a specific Item

Items possess their own unqiue IDs and are associated with a user by their userId. The user can create their own Items with their own customer names, descriptions and images. They can also provide the quantity of the item(s) and whether or not the item is complete (not missing any pieces).

Removes a specific Item from the database.

\n","urlObject":{"path":["Items",":id"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"c0fb5dc5-ff5c-4d32-b414-386b0b35f5be"},{"name":"CREATE Item","id":"4a990dfe-1a17-428b-901b-2d50c3df9de5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"id\": 0,\r\n \"name\": \"stri1ng\",\r\n \"description\": \"string\",\r\n \"containerId\": 0,\r\n \"quantity\": 0,\r\n \"complete\": true,\r\n \"userId\": 0,\r\n \"image\": \"string\"\r\n }","options":{"raw":{"language":"json"}}},"url":"http://localhost:5093/Items","description":"

Adds a new Item to the database.

The Item is associated with a user by their userId and with a Container by its containerId. The Item possesses a name, description, quantity, image link and can be complete or incomplete.

\n","urlObject":{"path":["Items"],"host":["http://localhost:5093"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a990dfe-1a17-428b-901b-2d50c3df9de5"},{"name":"GET Items by User Id","id":"2c46802c-457b-474d-88df-a6f5d73b607e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Items/User/:userId","description":"

Retrieves all of the Items for a specific User via their userId.

\n","urlObject":{"path":["Items","User",":userId"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"userId"}]}},"response":[],"_postman_id":"2c46802c-457b-474d-88df-a6f5d73b607e"},{"name":"UPDATE Item","id":"39f9d54b-2d8f-4f4f-8ee2-df18ff105c6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":" {\r\n \"id\": 0,\r\n \"name\": \"stri1ng\",\r\n \"description\": \"string\",\r\n \"containerId\": 0,\r\n \"quantity\": 0,\r\n \"complete\": true,\r\n \"userId\": 0,\r\n \"image\": \"string\"\r\n }","options":{"raw":{"language":"json"}}},"url":"http://localhost:5093/Items/:id","description":"

Updates a specific Item. The name, description, image, containerId, quantity and complete values can be modified. The userId can technically be modified, however this is unlikely to happen in a live scenario.

Manage collection Items.

Fields:

id: Unique identifier for the Item
\n
name: The name of the Item, entered by the user.
\n
description: A description of the Item, entered by the user.
\n
containerId: The Id of the Container associated with this Item.
\n
quantity: The number or amount of this particular Item.
\n
complete: True/False indicating whether or not the Item is missing any pieces.
\n
userId: A unique identifier for the user.
\n
image: An image of the Item, entered by the user.
\n

\n","_postman_id":"7b7b9662-99ee-4844-a63e-675bc6c5fb7c"},{"name":"ItemCategories","item":[{"name":"DELETE ItemCategory","id":"63cf1378-9885-4f31-b5b6-c23f0d9d5ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:5093/ItemCategory/:itemId/:categoryId","description":"

Removes a specific ItemCategory from the database.

Note: Both the Item and Category will NOT be deleted and will remain in the database, however the connection between the two will be severed.

\n","urlObject":{"path":["ItemCategory",":itemId",":categoryId"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"itemId"},{"type":"any","value":"","key":"categoryId"}]}},"response":[],"_postman_id":"63cf1378-9885-4f31-b5b6-c23f0d9d5ad5"},{"name":"CREATE ItemCategory","id":"3d2d5685-c52d-4bfa-adaa-8ade47a2c9a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:5093/ItemCategory/:itemId/:categoryId","description":"

Creates a new connection between an Item and Category and adds it to the database.

The ItemCategory is connected to a specific Item by itemId and to the Category by categoryId.

ItemCategories represent a join table between Items and Categories.

While each Item can possess multiple Categories and each Category can be assigned to multiple items-- the ItemCategory is unique and indicates a particular relationship between a specific Item and Category.

Fields:

itemId: Unique identifier for the Item
\n
categoryId: Unique identifier for the Category
\n

\n","_postman_id":"737cdbe0-164d-49da-a510-3c4c1b9e94ee"},{"name":"Locations","item":[{"name":"GET Single Location","id":"a899108b-2694-49cc-a052-6b98b078ea01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Locations/:id","description":"

Retrieves details about a specific Location.

Locations possess their own unqiue IDs and are associated with a user by their userId. The user can create their own Locations with their own custom Names and Descriptions.

\n","urlObject":{"path":["Locations",":id"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"a899108b-2694-49cc-a052-6b98b078ea01"},{"name":"DELETE Location","id":"4fc2a053-bf45-4a37-9553-3ab2b13bc1f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:5093/Locations/:id","description":"

Removes a Location from the Database.

Note: Only empty Locations can be deleted. Attempting to delete a Location with Containers associated with it will return an error.

\n","urlObject":{"path":["Locations",":id"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"4fc2a053-bf45-4a37-9553-3ab2b13bc1f0"},{"name":"GET Locations by UserId","id":"57f30138-3a4e-46e8-b890-b575921c4a3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Locations/User/:userId","description":"

Retrieves all of the Locations for a specific User via their userId.

\n","urlObject":{"path":["Locations","User",":userId"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"userId"}]}},"response":[],"_postman_id":"57f30138-3a4e-46e8-b890-b575921c4a3a"},{"name":"GET Locations by User UID","id":"ecd84276-7bb8-4b67-bfbc-d6eeda4a821e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Locations/UserUid/:Uid","description":"

Retrieves all of the Locations for a specific User via their Uid.

\n","urlObject":{"path":["Locations","UserUid",":Uid"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"Uid"}]}},"response":[],"_postman_id":"ecd84276-7bb8-4b67-bfbc-d6eeda4a821e"},{"name":"CREATE Location","id":"48c9bc22-f659-44da-8251-3ab42ad2331e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://localhost:5093/Locations","description":"

This endpoint creates a new Location and adds it to the database.

The Location is associated with a user by their userId and possesses a name and a description.

\n","urlObject":{"path":["Locations"],"host":["http://localhost:5093"],"query":[],"variable":[]}},"response":[],"_postman_id":"48c9bc22-f659-44da-8251-3ab42ad2331e"},{"name":"UPDATE Location","id":"f93500e6-be51-4f2f-8ee1-9cfc777da4a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n\"id\": 1,\r\n\"name\": \"string\",\r\n\"description\": \"string\",\r\n\"userId\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5093/Locations/:id","description":"

Updates a specific Location. The name and description can be modified. The userId can technically be modified, however this is unlikely to happen in a live scenario. The Location ID should not be altered.

Manage collection Locations.

Fields:

id: Unique identifier for the Location.
\n
name: The name of the Location, entered by the user.
\n
description: A description of the Location, entered by the user.
\n
userId: A unique identifier for the user.
\n

\n","_postman_id":"37518e30-a601-4647-bdb3-c710b4c93bf7"},{"name":"Users","item":[{"name":"CREATE User","id":"8597d4a1-e5e2-4205-b954-1360e45818e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 0,\r\n \"Uid\": \"abcdefg\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5093/Users","description":"

This endpoint creates a new User and adds it to the database.

The User entity has only has two values, an ID value created for that user and a Uid for use with user authentication. All other connections to the user are made on directly on the other entities.

\n","urlObject":{"path":["Users"],"host":["http://localhost:5093"],"query":[],"variable":[]}},"response":[],"_postman_id":"8597d4a1-e5e2-4205-b954-1360e45818e8"},{"name":"GET Single User","id":"e98439ad-f95e-4360-9695-7870168d32bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Users/:id","description":"

Retrieves details about a specific User via their Id.

\n","urlObject":{"path":["Users",":id"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"e98439ad-f95e-4360-9695-7870168d32bf"},{"name":"GET Single User by UID","id":"a05fbd07-0da9-4e48-9c3b-d5987bcf272c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:5093/Users/Uid/:uid","description":"

Retrieves details about a specific User via their Uid.

Useful when Creating new entities for the User as they can be verified by utilizing their Uid before the new object is created.

\n","urlObject":{"path":["Users","Uid",":uid"],"host":["http://localhost:5093"],"query":[],"variable":[{"type":"any","value":"","key":"uid"}]}},"response":[],"_postman_id":"a05fbd07-0da9-4e48-9c3b-d5987bcf272c"}],"id":"0147eef6-9bad-4303-86ab-78c34793573e","description":"

Manage collection Users.

Fields:

id: Unique identifier for the User.

\n","_postman_id":"0147eef6-9bad-4303-86ab-78c34793573e"}],"variable":[{"key":"databseURL","value":"http://localhost:5093","type":"default"}]}