API_Notice - Laterality/yummy-dishes-REST GitHub Wiki

---

Index

• 공지사항 등록
• 공지사항 조회
• 공지사항 리스트 조회
• 공지사항 갱신
• 공지사항 제거

---

---

공지사항를 등록하는 API입니다.

• URL

  /notice/register

• Method:

  POST

• URL Params

  none

• Data Params

  Body

  title

  string

  공지사항명

  category

  string

  공지사항 종류

  content

  string

  공지사항 내용

  author

  공지사항 작성자의 "_id" 필드값

• Success Response:

  • Code: 201
    Content:

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

    result

    string

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

    message

    string

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

    notice

    NoticeModel

    요청이 성공한 경우 생성된 공지사항 정보

• Error Response:

  • Code: 405 INVALID PARAMETERS
    Content:

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

  OR

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  {
    "title": "notice title1",
    "category": "공지",
    "content": "some notice content",
    "author": "..."
  }
  

• Notes:

  • 공지사항 작성은 관리자 권한(is_admin == true)을 가진 사용자만 가능합니다.

---

단일 공지사항을 조회하는 API입니다.

• URL

  /notice/{noticeId}

• Method:

  GET

• URL Params

  noticeId

  string

  조회할 공지사항의 "_id" 필드값

• Data Params

  none

• Success Response:

  • Code: 200
    Content:

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

    result

    string

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

    message

    string

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

    categories

    NoticeModel

    조회된 공지사항

• Error Response:

  • Code: 404 NOT FOUND
    Content:

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

  OR

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  GET /notice/...
  

• Notes:

  None

---

날짜 범위로 공지사항 리스트를 조회하는 API입니다.

• URL

  /notice/notices

• Method:

  GET

• URL Params

  Required:
  

  from

  Date

  조회 범위 시작 날짜

  to

  Date

  조회 범위 끝 날짜

  Optional:
  

  from

  string

  조회 범위 시작 날짜(기본값: 오늘)

  to

  string

  조회 범위 끝 날짜(기본값: 오늘)

• Data Params

  none

• Success Response:

  • Code: 200
    Content:

    { 
    	"result": "ok",
    	"notices": [
    		...
    	]
    }
    

    result

    string

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

    message

    string

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

    notices

    NoticesModel

    조회된 공지사항 배열

• Error Response:

  • Code: 405 INVALID PARAMETERS Content:

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

  OR

  • Code: 500 SERVER FAULT
    Content:

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

• Sample Call:

  GET /notice/notices?from=2017-09-18&to=2017-09-21
  

• Notes:

  • 날짜 형식은 "yyyy-mm-dd"입니다.

---

공지사항를 갱신하는 API입니다.

• URL

  /notice/{noticeId}/update

• Method:

  PUT

• URL Params

  Required:
  

  noticeId

  string

  공지사항의 "_id" 필드

• Data Params

  Body

  title
  string
  업데이트할 공지사항 제목
  category
  string
  업데이트할 공지사항 유형
  content
  string
  업데이트할 공지사항 내용

• 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:

  {
    "title": "Changed notice title"
  }
  

• Notes:

  None

---

공지사항를 제거하는 API입니다.

• URL

  /notice/{noticeId}/delete

• Method:

  DELETE

• URL Params

  Required:
  

  noticeId

  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: 500 SERVER FAULT
    Content:

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

• Sample Call:

  DELETE /notice/599a5eb80abb413e0a7abff4/delete
  

• Notes:

  none