Skip to content
This repository was archived by the owner on Jan 24, 2025. It is now read-only.

API Notification

Jang Ryeol edited this page Dec 26, 2017 · 15 revisions

GET notification/

ν˜„μž¬ μœ μ €μ˜ μ•Œλ¦Ό λͺ©λ‘μ„ λ°˜ν™˜ν•©λ‹ˆλ‹€.

URL Parameter

name description example
limit κ°€μ Έμ˜¬ μ•Œλ¦Ό 개수. Default = 20 20
offset μ˜€ν”„μ…‹ (for paging). Default = 0 0
explicit (Optional) 값에 관계없이 set되면 λ§ˆμ§€λ§‰ μ•Œλ¦Ό 체크 μ‹œκ°„μ„ μ—…λ°μ΄νŠΈν•©λ‹ˆλ‹€(Unread countλ₯Ό μ—…λ°μ΄νŠΈ). 값이 μ£Όμ–΄μ§€μ§€ μ•ŠμœΌλ©΄ μ—…λ°μ΄νŠΈν•˜μ§€ μ•ŠμŠ΅λ‹ˆλ‹€. 1

Output (Example)

[
  {
    "_id": "5790dde848c19cee16668b24",
    "message": "'Test Timetable' μ‹œκ°„ν‘œμ˜ 'κ³΅μ—°μ˜ˆμˆ μ˜ 이해' κ°•μ˜κ°€ μ—…λ°μ΄νŠΈ λ˜μ—ˆμŠ΅λ‹ˆλ‹€.",
    "created_at": "2016-07-21T14:36:24.322Z",
    "detail": {
      "lecture": {
        "course_title": "κ³΅μ—°μ˜ˆμˆ μ˜ 이해",
        "lecture_number": "001",
        "course_number": "042.023",
        "after": {
          "updated_at": 1469111784316,
          "course_title": "κ³΅μ—°μ˜ˆμˆ μ˜ 으미"
        },
        "before": {
          "course_title": "κ³΅μ—°μ˜ˆμˆ μ˜ 이해"
        }
      },
      "timetable_id": "578cdf57b805556d5e4f4d71"
    },
    "type": 2,
    "user_id": "578cb77b81d0bdfe3aef888f",
    "__v": 0
  },
  {
    "_id": "5790dde848c19cee16668b23",
    "message": "2015년도 κ²¨μšΈν•™κΈ° μˆ˜κ°• 편람이 μ—…λ°μ΄νŠΈ λ˜μ—ˆμŠ΅λ‹ˆλ‹€.",
    "created_at": "2016-07-21T14:36:24.306Z",
    "type": 1,
    "user_id": null,
    "__v": 0
  },
  {
    "_id": "5790de76756a8da1171269c4",
    "message": "'Test Timetable' μ‹œκ°„ν‘œμ˜ 'κ³΅μ—°μ˜ˆμˆ μ˜ 으미' κ°•μ˜κ°€ νκ°•λ˜μ—ˆμŠ΅λ‹ˆλ‹€.",
    "created_at": "2016-07-21T14:38:46.786Z",
    "detail": {
      "lecture": {
        "course_title": "κ³΅μ—°μ˜ˆμˆ μ˜ 으미",
        "lecture_number": "001",
        "course_number": "042.023"
      },
      "timetable_id": "578cdf57b805556d5e4f4d71"
    },
    "type": 3,
    "user_id": "578cb77b81d0bdfe3aef888f",
    "__v": 0
  }
]

detail 속성은 type에 따라 λ‹€λ₯Έ ꡬ쑰λ₯Ό κ°€μ§‘λ‹ˆλ‹€. Notification Details μ°Έκ³ .


GET notification/count

ν˜„μž¬ μœ μ €κ°€ 읽지 μ•Šμ€ μ•Œλ¦Όμ˜ 개수λ₯Ό λ°˜ν™˜ν•©λ‹ˆλ‹€.

Output (Example)

개수λ₯Ό λ°˜ν™˜

{
  "count": 7
}

Notification Details

ν˜„μž¬ Notificationμ—λŠ” 3κ°€μ§€ νƒ€μž…μ΄ μžˆμŠ΅λ‹ˆλ‹€.

Type Number Description
NORMAL 0 detail이 null인 일반 ν…μŠ€νŠΈ μ•Œλ¦Όμž…λ‹ˆλ‹€(홍보 λ“±).
COURSEBOOK 1 μˆ˜κ°•νŽΈλžŒμ΄ μΆ”κ°€λ˜μ—ˆμ„ λ•Œ λͺ¨λ“  μœ μ €μ—κ²Œ μ „μ†‘λ˜λŠ” μ „μ—­ μ•Œλ¦Όμž…λ‹ˆλ‹€(eg.17λ…„ 1ν•™κΈ° μˆ˜κ°•νŽΈλžŒμ΄ μƒˆλ‘œ λ‚˜μ™”μŠ΅λ‹ˆλ‹€).
LECTURE_UPDATE 2 λ‚΄ μ‹œκ°„ν‘œμ— μžˆλŠ” κ°•μ’Œκ°€ μ—…λ°μ΄νŠΈλ˜μ—ˆμ„ λ•Œ κ°•μ˜λ³„λ‘œ μ „μ†‘λ˜λŠ” 개인 μ•Œλ¦Όμž…λ‹ˆλ‹€.
LECTURE_REMOVE 3 λ‚΄ μ‹œκ°„ν‘œμ— μžˆλŠ” κ°•μ’Œκ°€ μ‚­μ œλ˜μ—ˆμ„ λ•Œ κ°•μ˜λ³„λ‘œ μ „μ†‘λ˜λŠ” 개인 μ•Œλ¦Όμž…λ‹ˆλ‹€.
LINK_ADDR 4 μ‚¬μš©μžκ°€ μ•ŒλžŒμ„ λˆ„λ₯΄λ©΄ νŠΉμ • 링크둜 μ—°κ²°λ˜λŠ” μ•Œλ¦Όμž…λ‹ˆλ‹€.

각 νƒ€μž… λ³„λ‘œ detail ν•„λ“œμ—λŠ” λ‹€λ₯Έ 값이 μ €μž₯λ˜μ–΄ μžˆμŠ΅λ‹ˆλ‹€. NORMALκ³Ό COURSEBOOK νƒ€μž…μ€ detail이 nullμž…λ‹ˆλ‹€.

LECTURE_UPDATE & LECTURE_REMOVE νƒ€μž…

{
  "lecture": {
    ".."
  },
  "timetable_id": ".."
}

timetable_idκ°€ μΆ”κ°€λ©λ‹ˆλ‹€. κ°•μ˜κ°€ μ—…λ°μ΄νŠΈ λ˜μ—ˆμ„ λ•Œμ™€ νκ°•λ˜μ—ˆμ„ λ•Œκ°€ λ‹€λ₯Έλ°, μžμ„Έν•œ μ˜ˆλŠ” μœ„ response μ˜ˆμ œλ“€μ„ μ°Έκ³ ν•΄μ£Όμ„Έμš”. κ°•μ˜ μ—…λ°μ΄νŠΈλ˜μ—ˆμœΌλ‚˜ μ‹œκ°„μ΄ 겹쳐 μ‚­μ œλ˜μ—ˆμ„ λ•Œμ—”, LECTURE_REMOVE νƒ€μž…μž…λ‹ˆλ‹€.

LINK_ADDR νƒ€μž…

링크 μ£Όμ†Œ λ¬Έμžμ—΄μ„ λ‹΄κ³  μžˆμŠ΅λ‹ˆλ‹€.

"https://snutt.kr"

Clone this wiki locally