API_SaleInfo - Laterality/yummy-dishes-REST GitHub Wiki

---

Index

• 판매정보 등록
• 판매정보 조회
• 날짜로 판매정보 조회
• 판매정보 갱신
• 판매정보 제거
• 타임세일 시작

---

---

판매정보를 등록하는 API입니다.

• URL

  /saleinfo/register

• Method:

  POST

• URL Params

  none

• Data Params

  Body

  prods

  Array<string>

  당일 판매되는 제품의 "_id" 필드값 배열

• Success Response:

  • Code: 201
    Content:

    { 
    	"result": "ok",
    	"saleinfo": {
    		...
    	}
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    saleInfo

    SaleInfoModel

    요청이 성공한 경우 생성된 판매정보

• Error Response:

  • Code: 405 INVALID PARAMETERS
    Content:

    {
    	"result": "fail",
    	"message": "invalid parameters"
    }
    

  OR

  • Code: 409 CONFLICT
    Content:

    {
    	"result": "fail",
    	"message": "today's sale info is already registered"
    }
    

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  {
    "prods": [
    	"...",
    	...
    ]
  }
  

• Notes:

  none

---

판매정보를 조회하는 API입니다.

• URL

  /saleinfo/{saleInfoId}

• Method:

  GET

• URL Params

  Required:

  saleInfoId

  string

  조회할 판매 정보의 "_id" 필드값

  Optional:

  populate

  string

  제품 정보를 함께 조회할 지 여부(기본값 "false")

• Data Params

  none

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok",
    	"saleInfo": {
    		...
    	}
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    saleInfo

    SaleInfoModel

    조회된 판매정보

• Error Response:

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  GET /saleinfo/59e1a50f46d6ad1e6050e6e3
  

• Notes:

  None

---

해당 날짜의 판매 정보를 조회합니다.

• URL

  /saleinfo/by-date

• Method:

  GET

• URL Params

  Optional:
  

  date

  Date

  조회할 날짜

  populate

  string

  제품 정보를 함께 조회할 지 여부(기본값: "false")

• Data Params

  none

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok",
    	"saleInfo": {
    		"_id": "...",
    		"prods_today": [
    			...
    		],
    		...
    	}
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

    saleInfo

    SaleInfoModel

    조회된 판매정보

• Error Response:

  • Code: 404 NOT FOUND Content:

    {
    	"result": "fail",
    	"message": "not found(saleInfo)"
    }
    

  OR

  • Code: 405 INVALID PARAMETERS Content:

    {
    	"result": "fail",
    	"message": "invalid parameters(date)"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  GET /saleinfo/by-date?date=2017-10-12
  

• Notes:

  None

---

판매정보를 갱신하는 API입니다.

• URL

  /saleinfo/{saleInfoId}/update

• Method:

  PUT

• URL Params

  Required:
  

  saleInfoId

  string

  판매정보의 "_id" 필드

• Data Params

  Body

  prods_today
  Array<string>
  업데이트될 제품의 "_id"필드값 배열

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

• Error Response:

  • Code: 404 NOT FOUND Content:

    {
    	"result": "fail",
    	"message": "not found"
    }
    

  OR

  • Code: 405 INVALID PARAMETERS Content:

    {
    	"result": "fail",
    	"message": "invalid parameters"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  {
    "prods_today": [
    	...
    ]
  }
  

• Notes:

  None

---

판매정보를 제거하는 API입니다.

• URL

  /saleinfo/{saleInfoId}/delete

• Method:

  DELETE

• URL Params

  Required:
  

  saleInfoId

  string

  판매정보의 "_id" 필드

• Data Params

  none

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

• Error Response:

  • Code: 404 NOT FOUND Content:

    {
    	"result": "fail",
    	"message": "not found"
    }
    

  OR

  • Code: 405 INVALID PARAMETERS Content:

    {
    	"result": "fail",
    	"message": "invalid parameters"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  DELETE /saleinfo/599a5eb80abb413e0a7abff4/delete
  

• Notes:

  none

---

타임세일을 시작하고 사용자들에게 푸시 알림을 보냅니다.

• URL

  /timesale/begin

• Method:

  POST

• URL Params

  Required:
  

  ratio

  string

  할인율(%단위)

  prods

  Array<string>

  타임세일 대상 제품들의 "_id"필드값 배열

• Data Params

  none

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok"
    }
    

    result

    string

    요청에 대한 처리 결과["ok", "fail", "error"]

    message

    string

    처리 결과에 대한 추가 메시지

• Error Response:

  • Code: 404 NOT FOUND Content:

    {
    	"result": "fail",
    	"message": "not found"
    }
    

  OR

  • Code: 405 INVALID PARAMETERS Content:

    {
    	"result": "fail",
    	"message": "invalid parameters"
    }
    

  OR

  • Code: 500 SERVER FAULT
    Content:

    {
    	"result": "error",
    	"message": "server fault"
    }
    

• Sample Call:

  {
    "ratio": "20",
    "prods": [
    	...
    ]
  }
  

• Notes:

  none