API

API

New Listing

/listings POST

Parameters

param	description	data type	examples	required
title	The title of the listing	String	City Scapes	true
description	The description of the listing	String	A beautiful set from the latest collection...	false
condition	The condition of the listing	String	Used	false
category	The category of the listing	String	Batman	true
email	The email address of the user that created the listing	String	me@example.com	true
category	The collection name from the manufacturer	String	Star Wars	false
zipCode	The zip code of where the lego set is located	String	20000	true
legoSetCode	The Lego set code for the listing	String	P42F36	false
imageUrl	An image URL of the listing	String	http://aws.com/bucket/images/listing/1/1.jpg	false

Request Format

{
    "title": "Star Wars Boba Fett",
    "description": "Brand new. My kid wanted Batman.",
    "condition": "New",
    "category": "Star Wars",
    "username": "SuburbanDad",
    "email": "bob@bob.com",
    "zipCode": "52645",
    "legoSetCode": "4D1F56",
    "imageUrl": "http://aws.com/bucket/images/listing/1/3.jpg"
}

Response Format

status: 201

Get Listings

/listings GET returns an array of listings. The results can be filtered by _id, category, zip code, or legoSetCode

Parameters

param	description	data type	examples	required
_id	The id of the listing	String	"5a590b8868bfac731cec4d85"	false
category	The category name from the manufacturer	String	Star Wars	false
location	The zip code of where the lego sets are located	String	20000	false
legoSetCode	The Lego set code for the listing	String	P42F36	false

Request Format to get a specific listing

{
  "_id": "5a590b8868bfac731cec4d85"
}

Response Format

status: 200

[
    {
        "_id": "5a590b8868bfac731cec4d85",
        "title": "Star Wars Boba Fett",
        "description": "Brand new. My kid wanted Batman.",
        "condition": "New",
        "category": "Star Wars",
        "username": "SuburbanDad",
        "email": "bob@bob.com",
        "zipCode": "52645",
        "legoSetCode": "4D1F56",
        "imageUrl": "http://aws.com/bucket/images/listing/1/3.jpg",
        "__v": 0,
        "createdAt": "2018-01-12T19:24:56.463Z"
    }
]

Request Format to get listings from a category

{
  "category": "Star Wars"
}

Response Format

status: 200

[
    {
        "_id": "5a590b8868bfac731cec4d85",
        "title": "Star Wars Boba Fett",
        "description": "Brand new. My kid wanted Batman.",
        "condition": "New",
        "category": "Star Wars",
        "username": "SuburbanDad",
        "email": "bob@bob.com",
        "zipCode": "52645",
        "legoSetCode": "4D1F56",
        "imageUrl": "http://aws.com/bucket/images/listing/1/3.jpg",
        "__v": 0,
        "createdAt": "2018-01-12T19:24:56.463Z"
    },
    {
        "_id": "5a590b4868bfac731cec4d84",
        "title": "Star Wars Luke's Island",
        "description": "Brand new. My kid wanted Batman.",
        "condition": "New",
        "category": "Star Wars",
        "username": "SuburbanDad",
        "email": "bob@bob.com",
        "zipCode": "52645",
        "legoSetCode": "444F56",
        "imageUrl": "http://aws.com/bucket/images/listing/1/2.jpg",
        "__v": 0,
        "createdAt": "2018-01-12T19:23:52.845Z"
    }
]

Delete a Listing

/listings DELETE

Parameters

param	description	data type	examples	required
:listingId	The id of the listing to be deleted	String	1000	true

Request Format

{
  "listingId": "1000"
}

Response Format

status: 201