GET /items : 取得物品搜尋清單

[Chun-Cheng]

輸入與輸出

• parameters
  • item_id (query)
    物品 _id
    string, optional
    format: Object ID /^[a-fA-F0-9]{24}$/
    example: "65f48bbc6f21a65d302a6147"
• response

  • status: 200 OK
    content: application/json

    if item_id was given, it'll return an object. Otherwise, it'll return an array.

    if item_id === undefined:

    • data: Array
      • _id: Object ID, 物品 _id
      • name: Object, 物品名稱
        • zh-tw: string, 物品中文名稱
        • en: string, item English name
      • quantity: integer, 物品數量
      • exception_time: Array
        • ......

    if item_id !== undefined:

    • _id: Object ID, 物品 _id
    • name: Object, 物品名稱
      • zh-tw: string, 物品中文名稱
      • en: string, item English name
    • quantity: integer, 物品數量
    • exception_time: Array
      • ......

    example: item_id: undefined

    {
      "data": [
        {
          "_id": "65f48bbc6f21a65d302a6147",
          "name": {
            "zh-tw": "塑膠椅",
            "en": "Plastic Chairs"
          },
          "quantity": 30,
          "exception_time": []
        },
        {
          "_id": "65f48bbc6f21a65d302a6148",
          "name": {
            "zh-tw": "長桌",
            "en": "Tables"
          },
          "quantity": 2,
          "exception_time": []
        }
      ]
    }
    
    

    item_id: "65f48bbc6f21a65d302a6147"

    {
      {
        "_id": "65f48bbc6f21a65d302a6147",
        "name": {
          "zh-tw": "塑膠椅",
          "en": "Plastic Chairs"
        },
        "quantity": 30,
        "exception_time": []
      }
    }
    
    

  • status: 404 Not found content: application/json

    • error_code: string, 錯誤代碼
    • message: string, 提示訊息

    example:

    {
      "error_code": "R_ID_NOT_FOUND", 
      "message": "Item ID not found"
    }
    

檔案

• /routes/reserve/get_items.js

資料集

• items

[linear]

URB-29 GET `/items` : 取得物品搜尋清單