API Document

API Document

Get a list of items according to client’s requirement

Method: Get
needToken: Yes
Request url: api/wishItem/?listType={“outstanding” / “history” / “all”}
Response:

{
 “wishItems”:
 [
   {
     “name” : “crisps”,
     “quantity” : 2, //
     “hasBrought” : true / false, //
     “buyRepetition” : 10
     noOfLikes:
     liked:
     snackImageUrl
     price
     requesterName //
     availableLocations
    _id // wish item id
    itemId // thing id
   },
   {
     “name” : “gummy bear”,
     “quantity” : 2,
     “hasBrought” : true / false,
     “BuyRepetition” : 10
     noOfLikes:
     liked:
     snackImageUrl
     price
     requester
     availableLocaltions
     _id // wish item id
     itemId // thing id
   }
 ]
}

Get a list of items according to popularity

Request url: api/things Method: Get
Response:

{
  “wishItems”:
  [
    {
      “name” : “crisps”,
      “quantity” : 2, //
      “hasBrought” : true / false, //
      “buyRepetition” : 10
      noOfLikes:
      liked:
      snackImageUrl
      price
      requesterName //
      availableLocations
	  _id // wish item id
	  itemId // thing id
    },
    {
      “name” : “gummy bear”,
      “quantity” : 2,
      “hasBrought” : true / false,
      “BuyRepetition” : 10
      noOfLikes:
      liked:
      snackImageUrl
      price
      requester
      availableLocaltions
	  _id // wish item id
	  itemId // thing id
    }
  ]
}

Create a wish item

Request url: api/wishItem
Method: Post
Request body

{
  “name” : “crisps”,
  “quantity” : 2,
  “snackImageUrl” : String,
  “price” : 123,
  “availableLocations” : [“abc”, “efg”]
}

Response:

{ result: true}

Mark wish item as brought

Request url: api/wishItem/markAsBrought
Method: Update
Request body:

{
  “objectIds”:
  [
    “123abc”, “123abc”
  ]
}

Response:

{ }

Update wish item quantity

Request url: api/wishItem/updateQuantity Method: Update Request body:

{
  “objectId”: “123abc”,
  “addOrMinus”: “add” / minus“”
}

Response:

{ }

Like / Unlike a wishItem

Request url: api/things/likeOrUnlike
Method: Put
Request body:

{
  “objectId” : “123abc”,
  “liked” : true / false
}

Response:

{
  “result” : true / false
  “error” : “User already liked this item” / “User never like this item” // Only show up is result is false
}