{"info":{"_postman_id":"25c78644-5c39-46ed-b01e-64ef9f9a7ff9","name":"TechTrader API","description":"

Hello and welcome to the TechTrader API docs! This API allows users to perform CRUD (Create, Read, Update, Delete) operations on multiple entities for the TechTrader application.

\n

Getting Started

\n

Follow these steps to get up and running with the TechTrader API:

\n

1. Fork the Postman Collection

\n

First, fork this Postman collection to your own Postman workspace. This will allow you to test and interact with the API using the provided examples.

\n

2. Fork the Repository

\n

Next, fork and clone this repository to your local machine. This API is built with C#/.NET and uses Entity Framework Core (EF Core) with PostgreSQL, so make sure you have those set up.

\n

3. Install Required Packages

\n

Once the repository is cloned, navigate to the project directory in your terminal (within Visual Studio) and run the following commands to install necessary packages:

\n
dotnet add package Npgsql.EntityFrameworkCore.PostgreSQL --version 6.0\ndotnet add package Microsoft.EntityFrameworkCore.Design --version 6.0\n\n
\n

4. Set Up Secrets for PostgreSQL Connection

\n

To store sensitive connection details, initialize the secret storage with:

\n
dotnet user-secrets init\n\n
\n

Then, set the connection string for your PostgreSQL database (replace with your actual PostgreSQL password):

\n
dotnet user-secrets set \"TechTraderDbConnectionString\" \"Host=localhost;Port=5432;Username=postgres;Password=<your_postgresql_password>;Database=TechTrader\"\n\n
\n

5. Apply Migrations to the Database

\n

Run the following command to apply the database migrations:

\n
dotnet ef database update\n\n
\n

This will create the necessary tables and schema in your PostgreSQL database.

\n

6. Run the Solution

\n

Launch the solution in Visual Studio. Swagger should automatically launch and provide you with the API documentation. Copy the localhost URI Swagger provides and use it to configure Postman.

\n

7. Update the Postman Collection

\n

In Postman, update the base URI in your requests to reflect your local environment (e.g., https://localhost:7103).

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33562650","collectionId":"25c78644-5c39-46ed-b01e-64ef9f9a7ff9","publishedId":"2sAYBViBzx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-27T02:33:18.000Z"},"item":[{"name":"Listings","item":[{"name":"/listings","id":"84b9dcca-e553-495d-bf29-b5d550627ac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/listings","description":"

This endpoint retrieves a list of listings.

\n

Request

\n

No request body is required for this endpoint.

\n

Response

\n

The response is a JSON array containing listing objects with the following properties:

\n\n

The seller object contains information about the seller, including their personal details, city, state, zip code, and seller status. It also includes an array of paymentTypes and savedListings.

\n

The category object contains the category details, including the id and name.

\n

The condition object contains the condition details, including the id and name.

\n
Example Response Body
\n
[\n    {\n        \"id\": \"\",\n        \"sellerId\": \"\",\n        \"categoryId\": \"\",\n        \"conditionId\": \"\",\n        \"name\": \"\",\n        \"description\": \"\",\n        \"price\": \"\",\n        \"imageUrl\": \"\",\n        \"createdOn\": \"\",\n        \"sold\": \"\",\n        \"seller\": {\n            \"id\": \"\",\n            \"uid\": \"\",\n            \"firstName\": \"\",\n            \"lastName\": \"\",\n            \"email\": \"\",\n            \"imageUrl\": \"\",\n            \"city\": \"\",\n            \"state\": \"\",\n            \"zip\": \"\",\n            \"isSeller\": \"\",\n            \"paymentTypes\": [\n                {\n                    \"id\": \"\",\n                    \"name\": \"\",\n                    \"users\": [\n                        {\n                            \"value\": \"\"\n                        }\n                    ]\n                }\n            ],\n            \"savedListings\": [\n                {\n                    \"id\": \"\",\n                    \"userId\": \"\",\n                    \"listingId\": \"\",\n                    \"listing\": {\n                        \"value\": \"\"\n                    }\n                }\n            ]\n        },\n        \"category\": {\n            \"id\": \"\",\n            \"name\": \"\"\n        },\n        \"condition\": {\n            \"id\": \"\",\n            \"name\": \"\"\n        }\n    }\n]\n\n
\n","urlObject":{"path":["listings"],"host":["https://localhost:7103"],"query":[],"variable":[]}},"response":[{"id":"ba45cd20-bfd9-4ce1-874d-d42baf3d77ed","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/listings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]"}],"_postman_id":"84b9dcca-e553-495d-bf29-b5d550627ac6"},{"name":"/listings/sellers/:sellerId","id":"282ca6e6-2575-47bb-a804-d9747b9fffeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/listings/sellers/:sellerId","description":"

This endpoint retrieves a list of listings associated with a specific seller identified by the sellerId parameter.

\n

Request

\n

No request body is required for this endpoint.

\n
    \n
  • sellerId (path parameter) - The unique identifier of the seller for whom the listings are to be retrieved.
    • \n
\n

Response

\n

The response will be a JSON array containing objects with the following properties:

\n
    \n

  • id (string) - The unique identifier of the listing.

    \n
    • \n

  • sellerId (string) - The identifier of the seller associated with the listing.

    \n
    • \n

  • categoryId (string) - The identifier of the category to which the listing belongs.

    \n
    • \n

  • conditionId (string) - The identifier of the condition of the listing.

    \n
    • \n

  • name (string) - The name of the listing.

    \n
    • \n

  • description (string) - The description of the listing.

    \n
    • \n

  • price (string) - The price of the listing.

    \n
    • \n

  • imageUrl (string) - The URL of the image associated with the listing.

    \n
    • \n

  • createdOn (string) - The date and time when the listing was created.

    \n
    • \n

  • sold (boolean) - Indicates whether the listing has been sold.

    \n
    • \n

  • seller (object) - Details of the seller associated with the listing, including their unique identifier, name, email, address, and seller-specific information.

    \n
    • \n

  • category (object) - Details of the category to which the listing belongs, including its unique identifier and name.

    \n
    • \n

  • condition (object) - Details of the condition of the listing, including its unique identifier and name.

    \n
    • \n
\n

The seller object within the response contains the following properties:

\n
    \n

  • id (string) - The unique identifier of the seller.

    \n
    • \n

  • uid (string) - The user ID of the seller.

    \n
    • \n

  • firstName (string) - The first name of the seller.

    \n
    • \n

  • lastName (string) - The last name of the seller.

    \n
    • \n

  • email (string) - The email address of the seller.

    \n
    • \n

  • imageUrl (string) - The URL of the seller's image.

    \n
    • \n

  • city (string) - The city where the seller is located.

    \n
    • \n

  • state (string) - The state where the seller is located.

    \n
    • \n

  • zip (string) - The ZIP code of the seller's location.

    \n
    • \n

  • isSeller (boolean) - Indicates whether the user is a seller.

    \n
    • \n

  • paymentTypes (array) - An array of payment types accepted by the seller, including their unique identifiers, names, and associated users.

    \n
    • \n

  • savedListings (array) - An array of saved listings by the seller, including their unique identifiers, associated user IDs, and listing details.

    \n
    • \n
\n

The category object within the response contains the following properties:

\n
    \n

  • id (string) - The unique identifier of the category.

    \n
    • \n

  • name (string) - The name of the category.

    \n
    • \n
\n

The condition object within the response contains the following properties:

\n
    \n

  • id (string) - The unique identifier of the condition.

    \n
    • \n

  • name (string) - The name of the condition.

    \n
    • \n
\n

Example

\n
[\n  {\n    \"id\": \"\",\n    \"sellerId\": \"\",\n    \"categoryId\": \"\",\n    \"conditionId\": \"\",\n    \"name\": \"\",\n    \"description\": \"\",\n    \"price\": \"\",\n    \"imageUrl\": \"\",\n    \"createdOn\": \"\",\n    \"sold\": \"\",\n    \"seller\": {\n      \"id\": \"\",\n      \"uid\": \"\",\n      \"firstName\": \"\",\n      \"lastName\": \"\",\n      \"email\": \"\",\n      \"imageUrl\": \"\",\n      \"city\": \"\",\n      \"state\": \"\",\n      \"zip\": \"\",\n      \"isSeller\": \"\",\n      \"paymentTypes\": [\n        {\n          \"id\": \"\",\n          \"name\": \"\",\n          \"users\": [\n            {\n              \"value\": \"\"\n            }\n          ]\n        }\n      ],\n      \"savedListings\": [\n        {\n          \"id\": \"\",\n          \"userId\": \"\",\n          \"listingId\": \"\",\n          \"listing\": {\n            \"value\": \"\"\n          }\n        }\n      ]\n    },\n    \"category\": {\n      \"id\": \"\",\n      \"name\": \"\"\n    },\n    \"condition\": {\n      \"id\": \"\",\n      \"name\": \"\"\n    }\n  }\n]\n\n
\n","urlObject":{"path":["listings","sellers",":sellerId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"afdd226a-8904-4808-b510-8d323c031b54","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"sellerId"}]}},"response":[{"id":"3dca317a-fc59-4c5f-868a-8dde11824c04","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/listings/sellers/:sellerId","host":["https://localhost:7103"],"path":["listings","sellers",":sellerId"],"variable":[{"key":"sellerId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n]"}],"_postman_id":"282ca6e6-2575-47bb-a804-d9747b9fffeb"},{"name":"/listings/:listingId","id":"d9aa6c89-771e-41bd-a71a-c6530a53abef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/listings/:listingId","description":"

This endpoint retrieves the details of a specific listing identified by the listingId.

\n

Request

\n
    \n
  • Method: GET
    • \n
\n

Response

\n
    \n

  • Status: 200

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n
\n
{\n  \"id\": 0,\n  \"sellerId\": 0,\n  \"categoryId\": 0,\n  \"conditionId\": 0,\n  \"name\": \"\",\n  \"description\": \"\",\n  \"price\": 0,\n  \"imageUrl\": \"\",\n  \"createdOn\": \"\",\n  \"sold\": true,\n  \"seller\": {\n    \"id\": 0,\n    \"uid\": \"\",\n    \"firstName\": \"\",\n    \"lastName\": \"\",\n    \"email\": \"\",\n    \"imageUrl\": \"\",\n    \"city\": \"\",\n    \"state\": \"\",\n    \"zip\": \"\",\n    \"isSeller\": true,\n    \"paymentTypes\": null,\n    \"savedListings\": null\n  },\n  \"category\": {\n    \"id\": 0,\n    \"name\": \"\"\n  },\n  \"condition\": {\n    \"id\": 0,\n    \"name\": \"\"\n  }\n}\n\n
\n

Example Response

\n
{\n  \"id\": \"\",\n  \"sellerId\": \"\",\n  \"categoryId\": \"\",\n  \"conditionId\": \"\",\n  \"name\": \"\",\n  \"description\": \"\",\n  \"price\": \"\",\n  \"imageUrl\": \"\",\n  \"createdOn\": \"\",\n  \"sold\": \"\",\n  \"seller\": {\n    \"id\": \"\",\n    \"uid\": \"\",\n    \"firstName\": \"\",\n    \"lastName\": \"\",\n    \"email\": \"\",\n    \"imageUrl\": \"\",\n    \"city\": \"\",\n    \"state\": \"\",\n    \"zip\": \"\",\n    \"isSeller\": \"\",\n    \"paymentTypes\": [\n      {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"users\": [\n          {\n            \"value\": \"\"\n          }\n        ]\n      }\n    ],\n    \"savedListings\": [\n      {\n        \"id\": \"\",\n        \"userId\": \"\",\n        \"listingId\": \"\",\n        \"listing\": {\n          \"value\": \"\"\n        }\n      }\n    ]\n  },\n  \"category\": {\n    \"id\": \"\",\n    \"name\": \"\"\n  },\n  \"condition\": {\n    \"id\": \"\",\n    \"name\": \"\"\n  }\n}\n\n
\n","urlObject":{"path":["listings",":listingId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"ffeab83c-8134-4d19-b75b-cb65f7dc36bb","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"listingId"}]}},"response":[{"id":"2f7a600c-ceb6-4338-b932-92bc032a217c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/listings/:listingId","host":["https://localhost:7103"],"path":["listings",":listingId"],"variable":[{"key":"listingId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}"}],"_postman_id":"d9aa6c89-771e-41bd-a71a-c6530a53abef"},{"name":"/listings","id":"605f28c2-b960-4be6-8976-9f06089d3350","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/listings","description":"

This endpoint is used to create a new listing.

\n

Request Body

\n
    \n

  • id (integer)

    \n
    • \n

  • sellerId (integer)

    \n
    • \n

  • categoryId (integer)

    \n
    • \n

  • conditionId (integer)

    \n
    • \n

  • name (string)

    \n
    • \n

  • description (string)

    \n
    • \n

  • price (double)

    \n
    • \n

  • imageUrl (string)

    \n
    • \n

  • createdOn (dateTime)

    \n
    • \n

  • sold (boolean)

    \n
    • \n

  • seller (object)

    \n
      \n

    • id (integer)

      \n
      • \n

    • uid (string)

      \n
      • \n

    • firstName (string)

      \n
      • \n

    • lastName (string)

      \n
      • \n

    • email (string)

      \n
      • \n

    • imageUrl (string)

      \n
      • \n

    • city (string)

      \n
      • \n

    • state (string)

      \n
      • \n

    • zip (string)

      \n
      • \n

    • isSeller (boolean)

      \n
      • \n

    • paymentTypes (array)

      \n
        \n

      • id (integer)

        \n
        • \n

      • name (string)

        \n
        • \n

      • users (array)

        \n
          \n
        • value (string)
          • \n
        \n
        • \n
      \n
      • \n

    • savedListings (array)

      \n
        \n

      • id (integer)

        \n
        • \n

      • userId (integer)

        \n
        • \n

      • listingId (integer)

        \n
        • \n

      • listing (object)

        \n
          \n
        • value (string)
          • \n
        \n
        • \n
      \n
      • \n
    \n
    • \n

  • category (object)

    \n
      \n

    • id (integer)

      \n
      • \n

    • name (string)

      \n
      • \n
    \n
    • \n

  • condition (object)

    \n
      \n

    • id (integer)

      \n
      • \n

    • name (string)

      \n
      • \n
    \n
    • \n
\n

Response

\n

The response for this request follows the JSON schema:

\n
{\n  \"id\": \"\",\n  \"sellerId\": \"\",\n  \"categoryId\": \"\",\n  \"conditionId\": \"\",\n  \"name\": \"\",\n  \"description\": \"\",\n  \"price\": \"\",\n  \"imageUrl\": \"\",\n  \"createdOn\": \"\",\n  \"sold\": \"\",\n  \"seller\": {\n    \"id\": \"\",\n    \"uid\": \"\",\n    \"firstName\": \"\",\n    \"lastName\": \"\",\n    \"email\": \"\",\n    \"imageUrl\": \"\",\n    \"city\": \"\",\n    \"state\": \"\",\n    \"zip\": \"\",\n    \"isSeller\": \"\",\n    \"paymentTypes\": [\n      {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"users\": [\n          {\n            \"value\": \"\"\n          }\n        ]\n      }\n    ],\n    \"savedListings\": [\n      {\n        \"id\": \"\",\n        \"userId\": \"\",\n        \"listingId\": \"\",\n        \"listing\": {\n          \"value\": \"\"\n        }\n      }\n    ]\n  },\n  \"category\": {\n    \"id\": \"\",\n    \"name\": \"\"\n  },\n  \"condition\": {\n    \"id\": \"\",\n    \"name\": \"\"\n  }\n}\n\n
\n","urlObject":{"path":["listings"],"host":["https://localhost:7103"],"query":[],"variable":[]}},"response":[{"id":"5d8e38d3-ea22-42c4-8779-32aa200aab33","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/listings"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}"},{"id":"b0cdcc7e-7633-4a9a-a3a5-48bc3c3c3cf2","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/listings"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"605f28c2-b960-4be6-8976-9f06089d3350"},{"name":"/listings/:listingId","id":"70cb7ac5-f4fc-46ba-a41f-ca7ee92b6467","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/listings/:listingId","description":"

This endpoint allows the client to update the details of a specific listing identified by the listingId.

\n

Request Body

\n
    \n

  • id (number) - The unique identifier for the listing.

    \n
    • \n

  • sellerId (number) - The unique identifier of the seller.

    \n
    • \n

  • categoryId (number) - The unique identifier of the category to which the listing belongs.

    \n
    • \n

  • conditionId (number) - The unique identifier of the condition of the item.

    \n
    • \n

  • name (string) - The name or title of the listing.

    \n
    • \n

  • description (string) - A detailed description of the listing.

    \n
    • \n

  • price (number) - The price of the item.

    \n
    • \n

  • imageUrl (string) - The URL of the image associated with the listing.

    \n
    • \n

  • createdOn (string) - The date and time when the listing was created.

    \n
    • \n

  • sold (boolean) - Indicates whether the item is sold or not.

    \n
    • \n
\n

Response Body (JSON Schema)

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": { \"type\": \"number\" },\n    \"sellerId\": { \"type\": \"number\" },\n    \"categoryId\": { \"type\": \"number\" },\n    \"conditionId\": { \"type\": \"number\" },\n    \"name\": { \"type\": \"string\" },\n    \"description\": { \"type\": \"string\" },\n    \"price\": { \"type\": \"number\" },\n    \"imageUrl\": { \"type\": \"string\" },\n    \"createdOn\": { \"type\": \"string\" },\n    \"sold\": { \"type\": \"boolean\" },\n    \"seller\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": { \"type\": \"string\" },\n        \"uid\": { \"type\": \"string\" },\n        \"firstName\": { \"type\": \"string\" },\n        \"lastName\": { \"type\": \"string\" },\n        \"email\": { \"type\": \"string\" },\n        \"imageUrl\": { \"type\": \"string\" },\n        \"city\": { \"type\": \"string\" },\n        \"state\": { \"type\": \"string\" },\n        \"zip\": { \"type\": \"string\" },\n        \"isSeller\": { \"type\": \"string\" },\n        \"paymentTypes\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": { \"type\": \"string\" },\n              \"name\": { \"type\": \"string\" },\n              \"users\": {\n                \"type\": \"array\",\n                \"items\": {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"value\": { \"type\": \"string\" }\n                  }\n                }\n              }\n            }\n          }\n        },\n        \"savedListings\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"id\": { \"type\": \"string\" },\n              \"userId\": { \"type\": \"string\" },\n              \"listingId\": { \"type\": \"string\" },\n              \"listing\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"value\": { \"type\": \"string\" }\n                }\n              }\n            }\n          }\n        }\n      }\n    },\n    \"category\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": { \"type\": \"string\" },\n        \"name\": { \"type\": \"string\" }\n      }\n    },\n    \"condition\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": { \"type\": \"string\" },\n        \"name\": { \"type\": \"string\" }\n      }\n    }\n  }\n}\n\n
\n","urlObject":{"path":["listings",":listingId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"82cfe8e7-98c1-4036-8cdd-d39988154a96","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"listingId"}]}},"response":[{"id":"c6579768-0a81-4d86-8cd8-2550faa51a42","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://localhost:7103/listings/:listingId","host":["https://localhost:7103"],"path":["listings",":listingId"],"variable":[{"key":"listingId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}"},{"id":"39b58f0f-8f44-40d1-a542-251ee7fc1e69","name":"No Content","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://localhost:7103/listings/:listingId","host":["https://localhost:7103"],"path":["listings",":listingId"],"variable":[{"key":"listingId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"70cb7ac5-f4fc-46ba-a41f-ca7ee92b6467"},{"name":"/listings/:listingId","id":"3bd7c5c0-24c9-43dc-8afe-023a48f2be58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/listings/:listingId","description":"

This endpoint is used to delete a specific listing by providing the listing ID in the URL.

\n

Response

\n

The response for this request can be documented as a JSON schema as follows:

\n
{\n    \"type\": \"object\",\n    \"properties\": {\n        \"id\": {\"type\": \"string\"},\n        \"sellerId\": {\"type\": \"string\"},\n        \"categoryId\": {\"type\": \"string\"},\n        \"conditionId\": {\"type\": \"string\"},\n        \"name\": {\"type\": \"string\"},\n        \"description\": {\"type\": \"string\"},\n        \"price\": {\"type\": \"string\"},\n        \"imageUrl\": {\"type\": \"string\"},\n        \"createdOn\": {\"type\": \"string\"},\n        \"sold\": {\"type\": \"string\"},\n        \"seller\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"id\": {\"type\": \"string\"},\n                \"uid\": {\"type\": \"string\"},\n                \"firstName\": {\"type\": \"string\"},\n                \"lastName\": {\"type\": \"string\"},\n                \"email\": {\"type\": \"string\"},\n                \"imageUrl\": {\"type\": \"string\"},\n                \"city\": {\"type\": \"string\"},\n                \"state\": {\"type\": \"string\"},\n                \"zip\": {\"type\": \"string\"},\n                \"isSeller\": {\"type\": \"string\"},\n                \"paymentTypes\": {\n                    \"type\": \"array\",\n                    \"items\": {\n                        \"type\": \"object\",\n                        \"properties\": {\n                            \"id\": {\"type\": \"string\"},\n                            \"name\": {\"type\": \"string\"},\n                            \"users\": {\n                                \"type\": \"array\",\n                                \"items\": {\n                                    \"type\": \"object\",\n                                    \"properties\": {\n                                        \"value\": {\"type\": \"string\"}\n                                    }\n                                }\n                            }\n                        }\n                    }\n                },\n                \"savedListings\": {\n                    \"type\": \"array\",\n                    \"items\": {\n                        \"type\": \"object\",\n                        \"properties\": {\n                            \"id\": {\"type\": \"string\"},\n                            \"userId\": {\"type\": \"string\"},\n                            \"listingId\": {\"type\": \"string\"},\n                            \"listing\": {\n                                \"type\": \"object\",\n                                \"properties\": {\n                                    \"value\": {\"type\": \"string\"}\n                                }\n                            }\n                        }\n                    }\n                }\n            }\n        },\n        \"category\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"id\": {\"type\": \"string\"},\n                \"name\": {\"type\": \"string\"}\n            }\n        },\n        \"condition\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"id\": {\"type\": \"string\"},\n                \"name\": {\"type\": \"string\"}\n            }\n        }\n    }\n}\n\n
\n","urlObject":{"path":["listings",":listingId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"5d41cb48-60f3-45ec-9b4d-cf800be773a8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"listingId"}]}},"response":[{"id":"d9719afd-e1ea-4938-9db8-d588b3da9d00","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/listings/:listingId","host":["https://localhost:7103"],"path":["listings",":listingId"],"variable":[{"key":"listingId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"sellerId\": \"\",\n \"categoryId\": \"\",\n \"conditionId\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"price\": \"\",\n \"imageUrl\": \"\",\n \"createdOn\": \"\",\n \"sold\": \"\",\n \"seller\": {\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"category\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"condition\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n}"}],"_postman_id":"3bd7c5c0-24c9-43dc-8afe-023a48f2be58"}],"id":"ee2ff905-1a03-469c-a49c-cf620800a50f","description":"

This section contains requests to perform CRUD operations on listings. Users can:

\n
    \n

  • Retrieve all listings

    \n
    • \n

  • Retrieve all listings for a specific seller

    \n
    • \n

  • Retrieve listing details

    \n
    • \n

  • Create a listing

    \n
    • \n

  • Update a listing

    \n
    • \n

  • Delete a listing

    \n
    • \n
\n","_postman_id":"ee2ff905-1a03-469c-a49c-cf620800a50f"},{"name":"Categories","item":[{"name":"/categories","id":"01b1aec6-21c1-4e33-9c24-6012e4d0becc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/categories","description":"

This endpoint makes an HTTP GET request to retrieve a list of categories.

\n

Request

\n

No request body is required for this endpoint.

\n

Response

\n

The response will be a JSON array containing objects with the following properties:

\n
    \n

  • id: (string) The unique identifier for the category.

    \n
    • \n

  • name: (string) The name of the category.

    \n
    • \n
\n

JSON Schema

\n
{\n  \"type\": \"array\",\n  \"items\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"id\": {\n        \"type\": \"string\"\n      },\n      \"name\": {\n        \"type\": \"string\"\n      }\n    }\n  }\n}\n\n
\n","urlObject":{"path":["categories"],"host":["https://localhost:7103"],"query":[],"variable":[]}},"response":[{"id":"aad98082-7504-4acb-9e66-796683157846","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]"}],"_postman_id":"01b1aec6-21c1-4e33-9c24-6012e4d0becc"},{"name":"/categories","id":"95ff8e26-bebd-4cf4-b650-6f1048ad7056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/categories","description":"

This endpoint allows the client to create a new category.

\n

Request Body

\n
    \n

  • id (integer) - The unique identifier for the category.

    \n
    • \n

  • name (string) - The name of the category.

    \n
    • \n
\n

Response

\n

The response for this request is a JSON object with the following schema:

\n
{\n  \"id\": \"\",\n  \"name\": \"\"\n}\n\n
\n","urlObject":{"path":["categories"],"host":["https://localhost:7103"],"query":[],"variable":[]}},"response":[{"id":"6360c717-6653-4182-a72a-14f55342c4cf","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/categories"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\"\n}"},{"id":"0d1f2cfb-0083-44fa-873e-26a5d828a481","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/categories"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"95ff8e26-bebd-4cf4-b650-6f1048ad7056"},{"name":"/categories/:categoryId","id":"46111e5a-d52c-4dea-89eb-11c8e9e8a23b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/categories/:categoryId","description":"

This endpoint is used to update a specific category by its ID.

\n

Request Body

\n
    \n

  • id (integer) - The ID of the category to be updated.

    \n
    • \n

  • name (string) - The new name for the category.

    \n
    • \n
\n

Response

\n
    \n

  • If successful, the response will include the updated id and name of the category.

    \n
    • \n

  • If the category is not found, the response will be null.

    \n
    • \n
\n","urlObject":{"path":["categories",":categoryId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"72f9f4fa-2e27-4fb9-95ab-80e2a817d609","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"categoryId"}]}},"response":[{"id":"8e0ba840-56cf-4856-8aef-c5c3f25d8527","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://localhost:7103/categories/:categoryId","host":["https://localhost:7103"],"path":["categories",":categoryId"],"variable":[{"key":"categoryId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\"\n}"},{"id":"9d9e0c95-e594-42b4-aec4-e20057e747e3","name":"No Content","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"name\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://localhost:7103/categories/:categoryId","host":["https://localhost:7103"],"path":["categories",":categoryId"],"variable":[{"key":"categoryId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"46111e5a-d52c-4dea-89eb-11c8e9e8a23b"}],"id":"106db8d4-3d5c-470d-bafe-ea8d4f44e920","description":"

This section contains requests to perform CRUD operations on categories. Users can:

\n
    \n

  • Retrieve all categories

    \n
    • \n

  • Create a category

    \n
    • \n

  • Update a category

    \n
    • \n
\n","_postman_id":"106db8d4-3d5c-470d-bafe-ea8d4f44e920"},{"name":"Conditions","item":[{"name":"/conditions","id":"47ebdd57-6ba3-4f86-9bd1-45a25991226f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/conditions","description":"

This endpoint makes an HTTP GET request to retrieve a list of conditions.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • Path: /conditions

    \n
    • \n
\n

Headers

\n

No specific headers provided.

\n

Parameters

\n

No specific parameters provided.

\n

Response

\n
    \n

  • Status: 200 OK

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n
\n

Body

\n

The response body contains an array of conditions, where each condition object includes the following fields:

\n
    \n

  • id (string): The unique identifier for the condition.

    \n
    • \n

  • name (string): The name of the condition.

    \n
    • \n
\n

Example response body:

\n
[\n    {\n        \"id\": \"\",\n        \"name\": \"\"\n    }\n]\n\n
\n","urlObject":{"path":["conditions"],"host":["https://localhost:7103"],"query":[],"variable":[]}},"response":[{"id":"4659191a-1498-44b9-a197-22e285ebfe41","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/conditions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n]"}],"_postman_id":"47ebdd57-6ba3-4f86-9bd1-45a25991226f"}],"id":"d7dfe2b5-8708-498f-aeff-980a417f6249","description":"

This section contains requests to perform CRUD operations on conditions. Users can:

\n
    \n
  • Retrieve all conditions
    • \n
\n","_postman_id":"d7dfe2b5-8708-498f-aeff-980a417f6249"},{"name":"Payment Types","item":[{"name":"/payment-types","id":"8786e469-62fc-4281-ba0e-4139b0d1b994","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/payment-types","description":"

This endpoint makes an HTTP GET request to retrieve the list of payment types available.

\n

Response

\n
    \n

  • Status: 200

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n
\n

Example Response Body

\n
[\n    {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"users\": [\n            {\n                \"value\": \"\"\n            }\n        ]\n    }\n]\n\n
\n","urlObject":{"path":["payment-types"],"host":["https://localhost:7103"],"query":[],"variable":[]}},"response":[{"id":"54c38338-7934-4673-8cb8-dc4e103b5820","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/payment-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"8786e469-62fc-4281-ba0e-4139b0d1b994"},{"name":"/payment-types/:paymentTypeId/add/:userId","id":"40153437-31d1-4802-a674-ddcf93ad3b87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/payment-types/:paymentTypeId/add/:userId","description":"

This endpoint allows you to add a payment type for a specific user. The request should be sent as an HTTP POST to the specified URL, with the payment type ID and user ID included in the URL parameters.

\n

Request Body

\n

The request body should include the necessary parameters to add the payment type for the user.

\n

Response

\n

Upon successful execution, the response will contain the updated information related to the added payment type for the user.

\n

Example

\n
{}\n\n
\n","urlObject":{"path":["payment-types",":paymentTypeId","add",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"0b140ebe-1ebf-4466-8f65-feac44b30e1e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"paymentTypeId"},{"id":"88ce88cd-c3da-441f-b279-64355d458bc8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"b43bb9de-1b5c-4d3f-b9ba-64918eac65e8","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/payment-types/:paymentTypeId/add/:userId","host":["https://localhost:7103"],"path":["payment-types",":paymentTypeId","add",":userId"],"variable":[{"key":"paymentTypeId"},{"key":"userId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"40153437-31d1-4802-a674-ddcf93ad3b87"},{"name":"/payment-types/:paymentTypeId/remove/:userId","id":"b18a314f-058b-4cef-ad2d-c033cc92cb6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/payment-types/:paymentTypeId/remove/:userId","description":"

This endpoint is used to remove a specific payment type for a user.

\n

Request Body

\n

This request does not require a request body.

\n

Response

\n

The response for this request will be an empty object {}.

\n","urlObject":{"path":["payment-types",":paymentTypeId","remove",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"1823ab65-ad64-4cc5-9e00-3f0456c51534","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"paymentTypeId"},{"id":"2c0629ad-4e78-4104-8ea8-4ffd4e790395","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"69ca6467-d75e-4dde-beea-60d3095ec1cc","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/payment-types/:paymentTypeId/remove/:userId","host":["https://localhost:7103"],"path":["payment-types",":paymentTypeId","remove",":userId"],"variable":[{"key":"paymentTypeId"},{"key":"userId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"b18a314f-058b-4cef-ad2d-c033cc92cb6d"}],"id":"a3f3a5ef-c837-4c59-82f3-116fa6fee776","description":"

This section contains requests to perform CRUD operations on payment types. Users can:

\n
    \n

  • Retrieve all payment types

    \n
    • \n

  • Add a user payment type

    \n
    • \n

  • Remove a user payment type

    \n
    • \n
\n","_postman_id":"a3f3a5ef-c837-4c59-82f3-116fa6fee776"},{"name":"Messages","item":[{"name":"/messages/:userId","id":"5b68865c-f083-487f-9ac1-7450bc8022cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/messages/:userId","description":"

This endpoint retrieves messages for a specific user identified by the userId parameter.

\n

Request

\n
    \n
  • Method: GET
    • \n
\n

Response

\n

The response will include an array of message objects, each containing the following properties:

\n
    \n

  • id (string): The unique identifier of the message.

    \n
    • \n

  • senderId (string): The identifier of the message sender.

    \n
    • \n

  • receiverId (string): The identifier of the message receiver.

    \n
    • \n

  • listingId (string): The identifier of the associated listing, if applicable.

    \n
    • \n

  • content (string): The content of the message.

    \n
    • \n

  • sentAt (string): The timestamp indicating when the message was sent.

    \n
    • \n
\n","urlObject":{"path":["messages",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"96302b6d-5091-4807-8706-e33e38a4c1cd","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"ecd4bb97-f405-4ab6-a32c-db5fb3ced618","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/messages/:userId","host":["https://localhost:7103"],"path":["messages",":userId"],"variable":[{"key":"userId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n },\n {\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n }\n]"}],"_postman_id":"5b68865c-f083-487f-9ac1-7450bc8022cf"},{"name":"/messages/:userId/sellers/:sellerId","id":"d8d829e3-6b9e-411b-bb6b-aebfb6ff2892","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/messages/:userId/sellers/:sellerId","description":"

The endpoint retrieves messages between a specific user and seller. The response for this request can be documented as a JSON schema as follows:

\n
{\n  \"type\": \"array\",\n  \"items\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"id\": { \"type\": \"string\" },\n      \"senderId\": { \"type\": \"string\" },\n      \"receiverId\": { \"type\": \"string\" },\n      \"listingId\": { \"type\": \"string\" },\n      \"content\": { \"type\": \"string\" },\n      \"sentAt\": { \"type\": \"string\" }\n    }\n  }\n}\n\n
\n","urlObject":{"path":["messages",":userId","sellers",":sellerId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"796c45eb-f681-4e7f-abe5-2239db8a6817","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"},{"id":"259f14ef-327e-4f33-abf2-c080cd2e94f2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"sellerId"}]}},"response":[{"id":"7dd9511f-8131-4d61-b17c-afda88ea46ad","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/messages/:userId/sellers/:sellerId","host":["https://localhost:7103"],"path":["messages",":userId","sellers",":sellerId"],"variable":[{"key":"userId"},{"key":"sellerId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n },\n {\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n }\n]"}],"_postman_id":"d8d829e3-6b9e-411b-bb6b-aebfb6ff2892"},{"name":"/messages/latest/:userId","id":"4af9b39d-f06d-44c3-933b-8a7aa8465166","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/messages/latest/:userId","description":"

The endpoint retrieves the latest messages for a specific user based on the provided user ID. The response for this request can be documented as a JSON schema as follows:

\n
{\n  \"type\": \"array\",\n  \"items\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"id\": { \"type\": \"string\" },\n      \"senderId\": { \"type\": \"string\" },\n      \"receiverId\": { \"type\": \"string\" },\n      \"listingId\": { \"type\": \"string\" },\n      \"content\": { \"type\": \"string\" },\n      \"sentAt\": { \"type\": \"string\" }\n    }\n  }\n}\n\n
\n","urlObject":{"path":["messages","latest",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"6d4a9699-3225-4cdd-8c12-c65688f0630c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"49b9a682-6453-4c0f-af7d-4accbbb8229d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/messages/latest/:userId","host":["https://localhost:7103"],"path":["messages","latest",":userId"],"variable":[{"key":"userId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n },\n {\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n }\n]"}],"_postman_id":"4af9b39d-f06d-44c3-933b-8a7aa8465166"},{"name":"/messages","id":"c3e09267-76d0-43e1-9ca9-3f9b149f7247","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/messages","description":"

This endpoint is used to send a message with the specified payload.

\n

Request Body

\n
    \n

  • id (integer): The unique identifier for the message.

    \n
    • \n

  • senderId (integer): The ID of the sender of the message.

    \n
    • \n

  • receiverId (integer): The ID of the receiver of the message.

    \n
    • \n

  • listingId (integer): The ID of the listing associated with the message.

    \n
    • \n

  • content (string): The content of the message.

    \n
    • \n

  • sentAt (dateTime): The timestamp when the message was sent.

    \n
    • \n
\n

Response

\n

The response for this request follows the JSON schema below:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"senderId\": {\"type\": \"string\"},\n    \"receiverId\": {\"type\": \"string\"},\n    \"listingId\": {\"type\": \"string\"},\n    \"content\": {\"type\": \"string\"},\n    \"sentAt\": {\"type\": \"string\"}\n  }\n}\n\n
\n","urlObject":{"path":["messages"],"host":["https://localhost:7103"],"query":[],"variable":[]}},"response":[{"id":"bec4015c-f1a8-4cdc-ab63-8a812c895722","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/messages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}"},{"id":"cdacca4f-cd70-46fb-816e-e1a3118d7704","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/messages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c3e09267-76d0-43e1-9ca9-3f9b149f7247"},{"name":"/messages/:messageId","id":"6c3c0ee0-0b01-4699-9d47-4ac01c3491cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/messages/:messageId","description":"

This endpoint is used to update a specific message by providing the message ID in the URL.

\n

Request Body

\n
    \n

  • id (integer) - The ID of the message.

    \n
    • \n

  • senderId (integer) - The ID of the sender.

    \n
    • \n

  • receiverId (integer) - The ID of the receiver.

    \n
    • \n

  • listingId (integer) - The ID of the listing related to the message.

    \n
    • \n

  • content (string) - The content of the message.

    \n
    • \n

  • sentAt (dateTime) - The timestamp when the message was sent.

    \n
    • \n
\n

Response

\n

The response of this request can be represented as a JSON schema:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"senderId\": {\"type\": \"string\"},\n    \"receiverId\": {\"type\": \"string\"},\n    \"listingId\": {\"type\": \"string\"},\n    \"content\": {\"type\": \"string\"},\n    \"sentAt\": {\"type\": \"string\"}\n  }\n}\n\n
\n

In case of a successful update, the response will contain the updated message details. If the message is not found, the response will be null.

\n","urlObject":{"path":["messages",":messageId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"24bbee8c-29db-455c-87a5-922e004ca31a","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"messageId"}]}},"response":[{"id":"0156f0b8-6e54-4b71-b0d7-014ddfa4fc59","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://localhost:7103/messages/:messageId","host":["https://localhost:7103"],"path":["messages",":messageId"],"variable":[{"key":"messageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}"},{"id":"7e5d05c7-70e1-42b0-a532-127fb91dbde8","name":"No Content","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://localhost:7103/messages/:messageId","host":["https://localhost:7103"],"path":["messages",":messageId"],"variable":[{"key":"messageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6c3c0ee0-0b01-4699-9d47-4ac01c3491cd"},{"name":"/messages/:messageId","id":"07727ce7-4aaa-4e61-9c89-d593810175d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/messages/:messageId","description":"

The endpoint sends an HTTP DELETE request to delete a specific message with the provided messageId in the URL.

\n

Response

\n

The response will be in JSON format and will have the following schema:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"senderId\": {\"type\": \"string\"},\n    \"receiverId\": {\"type\": \"string\"},\n    \"listingId\": {\"type\": \"string\"},\n    \"content\": {\"type\": \"string\"},\n    \"sentAt\": {\"type\": \"string\"}\n  }\n}\n\n
\n","urlObject":{"path":["messages",":messageId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"9bbb25bd-08c6-466a-8e1f-b8d7a83709c8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"messageId"}]}},"response":[{"id":"81e1ee6f-1051-41ba-9b3e-7657a132051b","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/messages/:messageId","host":["https://localhost:7103"],"path":["messages",":messageId"],"variable":[{"key":"messageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}"}],"_postman_id":"07727ce7-4aaa-4e61-9c89-d593810175d3"},{"name":"/messages/:userId/sellers/:sellerId","id":"0f89413b-f90d-47ad-abe4-b907e7925918","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/messages/:userId/sellers/:sellerId","description":"

This endpoint sends an HTTP DELETE request to delete a conversation between a specific user and seller. The request should include the userId and sellerId in the URL parameters.

\n

Request Body

\n

This request does not require a request body.

\n

Response

\n

The response will include the details of the deleted message, such as the id, senderId, receiverId, listingId, content, and sentAt timestamp.

\n","urlObject":{"path":["messages",":userId","sellers",":sellerId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"3246e5a1-cba1-4a4f-bb5d-a0c525c4a2f8","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"},{"id":"5a7158c1-8dde-4c21-b66a-b30a475a58f7","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"sellerId"}]}},"response":[{"id":"be35962d-aaba-48fb-ac2e-860df4548430","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/messages/:userId/sellers/:sellerId","host":["https://localhost:7103"],"path":["messages",":userId","sellers",":sellerId"],"variable":[{"key":"userId"},{"key":"sellerId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"senderId\": \"\",\n \"receiverId\": \"\",\n \"listingId\": \"\",\n \"content\": \"\",\n \"sentAt\": \"\"\n}"}],"_postman_id":"0f89413b-f90d-47ad-abe4-b907e7925918"}],"id":"df8ce0cf-5854-495c-8a03-a9c6991dcaf3","description":"

This section contains requests to perform CRUD operations on messages. Users can:

\n
    \n

  • Retrieve all user messages

    \n
    • \n

  • Retrieve all messages in a conversation

    \n
    • \n

  • Retrieve the latest messages for all conversations

    \n
    • \n

  • Send a new message

    \n
    • \n

  • Update a message

    \n
    • \n

  • Delete a message

    \n
    • \n

  • Delete a conversation

    \n
    • \n
\n","_postman_id":"df8ce0cf-5854-495c-8a03-a9c6991dcaf3"},{"name":"Saved Listings","item":[{"name":"/saved-listings/:userId","id":"06beda4f-91b6-4e3d-a349-07457eba67f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/saved-listings/:userId","description":"

This endpoint retrieves the saved listings for a specific user.

\n

Request

\n
    \n
  • Method: GET
    • \n
\n

Response

\n

The response will be a JSON array containing saved listing objects with the following schema:

\n
[\n    {\n        \"id\": \"string\",\n        \"userId\": \"string\",\n        \"listingId\": \"string\",\n        \"listing\": {\n            \"value\": \"string\"\n        }\n    }\n]\n\n
\n","urlObject":{"path":["saved-listings",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"e2e2479a-1638-4eb9-b8c1-87741c042911","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"d6f5bd56-345b-45b1-8014-c8b7cb61ef0e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/saved-listings/:userId","host":["https://localhost:7103"],"path":["saved-listings",":userId"],"variable":[{"key":"userId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n]"}],"_postman_id":"06beda4f-91b6-4e3d-a349-07457eba67f7"},{"name":"/saved-listings/:listingId/add/:userId","id":"8c8525d0-dc5b-4375-9b15-c74fdd9ac81b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/saved-listings/:listingId/add/:userId","description":"

The endpoint allows adding a specific user to the saved listings for a particular listing.

\n

Response

\n

The response for this request can be documented as the JSON schema below.

\n","urlObject":{"path":["saved-listings",":listingId","add",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"5440e37f-138c-4cdf-a82f-8258da815f9c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"listingId"},{"id":"67f62d30-4dc8-44b4-af4f-41824908fe25","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"b1adf774-7cc4-45a2-b1b0-63158f5cf7b5","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/saved-listings/:listingId/add/:userId","host":["https://localhost:7103"],"path":["saved-listings",":listingId","add",":userId"],"variable":[{"key":"listingId"},{"key":"userId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"8c8525d0-dc5b-4375-9b15-c74fdd9ac81b"},{"name":"/saved-listings/:listingId/remove/:userId","id":"055a00b1-7264-47bf-a53e-b112d1abf5a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/saved-listings/:listingId/remove/:userId","description":"

This endpoint is used to remove a specific user from the saved listings.

\n

Request

\n
    \n
  • Method: DELETE
    • \n
\n

Response

\n

The response for this request can be represented as a JSON schema:

\n","urlObject":{"path":["saved-listings",":listingId","remove",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"2984aa96-1297-4988-84f7-b4ba90f69cf3","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"listingId"},{"id":"7aaebc4c-8d27-47dd-8e8e-099b5572ce33","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"c9fd84fc-ebca-434a-989a-6cd9e0c8a754","name":"No Content","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/saved-listings/:listingId/remove/:userId","host":["https://localhost:7103"],"path":["saved-listings",":listingId","remove",":userId"],"variable":[{"key":"listingId"},{"key":"userId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"055a00b1-7264-47bf-a53e-b112d1abf5a0"}],"id":"c474e2e9-4663-499e-9d03-45af0436fc44","description":"

This section contains requests to perform CRUD operations on saved listings. Users can:

\n
    \n

  • Retrieve all of a user's saved listings

    \n
    • \n

  • Add a saved listing

    \n
    • \n

  • Remove a saved listing

    \n
    • \n
\n","_postman_id":"c474e2e9-4663-499e-9d03-45af0436fc44"},{"name":"Users","item":[{"name":"/users/:userId","id":"0edc0042-1e07-4cfe-9c75-ec94a368714b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://localhost:7103/users/:userId","description":"

This endpoint retrieves details of a specific user identified by the userId.

\n

Request

\n
    \n
  • Method: GET
    • \n
\n

Response

\n

The response for this request can be represented as a JSON schema:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": {\"type\": \"string\"},\n    \"uid\": {\"type\": \"string\"},\n    \"firstName\": {\"type\": \"string\"},\n    \"lastName\": {\"type\": \"string\"},\n    \"email\": {\"type\": \"string\"},\n    \"imageUrl\": {\"type\": \"string\"},\n    \"city\": {\"type\": \"string\"},\n    \"state\": {\"type\": \"string\"},\n    \"zip\": {\"type\": \"string\"},\n    \"isSeller\": {\"type\": \"boolean\"},\n    \"paymentTypes\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": {\"type\": \"string\"},\n          \"name\": {\"type\": \"string\"},\n          \"users\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"value\": {\"type\": \"string\"}\n              }\n            }\n          }\n        }\n      }\n    },\n    \"savedListings\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": {\"type\": \"string\"},\n          \"userId\": {\"type\": \"string\"},\n          \"listingId\": {\"type\": \"string\"},\n          \"listing\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"value\": {\"type\": \"string\"}\n            }\n          }\n        }\n      }\n    }\n  }\n}\n\n
\n","urlObject":{"path":["users",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"b7a508e3-7489-4110-9958-1340c73ac0c9","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"ca06e902-d220-48a3-8e2f-c3d122f3f5c1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://localhost:7103/users/:userId","host":["https://localhost:7103"],"path":["users",":userId"],"variable":[{"key":"userId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n}"}],"_postman_id":"0edc0042-1e07-4cfe-9c75-ec94a368714b"},{"name":"/users","id":"bcfa05dd-1e98-4e29-9cae-84b0baf2ce19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/users","description":"

The POST request to /users endpoint is used to create a new user with the provided details. The request payload should include the user's ID, UID, first name, last name, email, image URL, city, state, zip, seller status, payment types, and saved listings.

\n

Request Body

\n
    \n

  • id (integer): The unique identifier for the user.

    \n
    • \n

  • uid (string): The unique identifier for the user.

    \n
    • \n

  • firstName (string): The first name of the user.

    \n
    • \n

  • lastName (string): The last name of the user.

    \n
    • \n

  • email (string): The email address of the user.

    \n
    • \n

  • imageUrl (string): The URL of the user's image.

    \n
    • \n

  • city (string): The city where the user is located.

    \n
    • \n

  • state (string): The state where the user is located.

    \n
    • \n

  • zip (string): The zip code of the user's location.

    \n
    • \n

  • isSeller (boolean): Indicates whether the user is a seller.

    \n
    • \n

  • paymentTypes (array): An array of payment types associated with the user, where each type includes an ID and a name.

    \n
    • \n

  • savedListings (array): An array of saved listings associated with the user, where each listing includes an ID, user ID, and listing ID.

    \n
    • \n
\n

Response

\n

The response for this request follows the JSON schema below:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": { \"type\": \"string\" },\n    \"uid\": { \"type\": \"string\" },\n    \"firstName\": { \"type\": \"string\" },\n    \"lastName\": { \"type\": \"string\" },\n    \"email\": { \"type\": \"string\" },\n    \"imageUrl\": { \"type\": \"string\" },\n    \"city\": { \"type\": \"string\" },\n    \"state\": { \"type\": \"string\" },\n    \"zip\": { \"type\": \"string\" },\n    \"isSeller\": { \"type\": \"string\" },\n    \"paymentTypes\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": { \"type\": \"string\" },\n          \"name\": { \"type\": \"string\" },\n          \"users\": {\n            \"type\": \"array\",\n            \"items\": { \"type\": \"string\" }\n          }\n        }\n      }\n    },\n    \"savedListings\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"id\": { \"type\": \"string\" },\n          \"userId\": { \"type\": \"string\" },\n          \"listingId\": { \"type\": \"string\" },\n          \"listing\": { \"type\": \"string\" }\n        }\n      }\n    }\n  }\n}\n\n
\n","urlObject":{"path":["users"],"host":["https://localhost:7103"],"query":[],"variable":[]}},"response":[{"id":"d8a12210-e159-4a0e-9846-fbb95708ac17","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n}"},{"id":"43adf363-08a7-477d-a871-21e835c4cb4e","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/users"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"bcfa05dd-1e98-4e29-9cae-84b0baf2ce19"},{"name":"/users/:userId","id":"3a9eaad7-b9df-4b9e-93cd-ee60b0ff8876","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://localhost:7103/users/:userId","description":"

This endpoint allows updating user details by providing the user ID and a JSON payload in the request body.

\n

Request Body

\n
    \n

  • id (integer) - The unique identifier for the user.

    \n
    • \n

  • uid (string) - The user's unique identifier.

    \n
    • \n

  • firstName (string) - The user's first name.

    \n
    • \n

  • lastName (string) - The user's last name.

    \n
    • \n

  • email (string) - The user's email address.

    \n
    • \n

  • imageUrl (string) - The URL of the user's profile image.

    \n
    • \n

  • city (string) - The user's city.

    \n
    • \n

  • state (string) - The user's state.

    \n
    • \n

  • zip (string) - The user's ZIP code.

    \n
    • \n

  • isSeller (boolean) - Indicates whether the user is a seller.

    \n
    • \n

  • paymentTypes (array) - An array of payment types associated with the user, each containing:

    \n
      \n

    • id (integer) - The unique identifier for the payment type.

      \n
      • \n

    • name (string) - The name of the payment type.

      \n
      • \n

    • users - Circular reference to the user's details.

      \n
      • \n
    \n
    • \n

  • savedListings (array) - An array of saved listings associated with the user, each containing:

    \n
      \n

    • id (integer) - The unique identifier for the saved listing.

      \n
      • \n

    • userId (integer) - The user ID associated with the saved listing.

      \n
      • \n

    • listingId (integer) - The ID of the saved listing.

      \n
      • \n

    • listing - Circular reference to the listing details.

      \n
      • \n
    \n
    • \n
\n

Response

\n

The response for this request can be represented as a JSON schema with the following structure:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"id\": { \"type\": \"string\" },\n    \"name\": { \"type\": \"string\" },\n    \"users\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"value\": { \"type\": \"string\" }\n        }\n      }\n    }\n  },\n  \"required\": [\"id\", \"name\", \"users\"]\n}\n\n
\n","urlObject":{"path":["users",":userId"],"host":["https://localhost:7103"],"query":[],"variable":[{"id":"826ee0db-cb0f-4408-b108-82792bf321fe","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"10d865df-aedd-4d62-8a4d-b1fa986656b9","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://localhost:7103/users/:userId","host":["https://localhost:7103"],"path":["users",":userId"],"variable":[{"key":"userId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}"},{"id":"07953a7a-310a-4832-8027-375e989b7cb4","name":"No Content","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"\",\n \"uid\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"imageUrl\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zip\": \"\",\n \"isSeller\": \"\",\n \"paymentTypes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"users\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ],\n \"savedListings\": [\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"userId\": \"\",\n \"listingId\": \"\",\n \"listing\": {\n \"value\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://localhost:7103/users/:userId","host":["https://localhost:7103"],"path":["users",":userId"],"variable":[{"key":"userId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3a9eaad7-b9df-4b9e-93cd-ee60b0ff8876"}],"id":"1b3b2e97-cdcc-4695-ad54-eaf5b639aef1","description":"

This section contains requests to perform CRUD operations on users. Users can:

\n
    \n

  • Retrieve user details

    \n
    • \n

  • Create a new user

    \n
    • \n

  • Update user details

    \n
    • \n
\n","_postman_id":"1b3b2e97-cdcc-4695-ad54-eaf5b639aef1"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"41fe0023-c7ed-48f5-9fca-e6e9e2ce2356"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"b6aa5dfb-1bbb-4516-9019-ee9affa91deb"}}],"variable":[{"key":"baseUrl","value":"https://localhost:7103"}]}