Skip to content
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 필드에는 다른 값이 저장되어 있습니다. NORMALCOURSEBOOK 타입은 detail이 null입니다.

LECTURE_UPDATE & LECTURE_REMOVE 타입

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

timetable_id가 추가됩니다. 강의가 업데이트 되었을 때와 폐강되었을 때가 다른데, 자세한 예는 위 response 예제들을 참고해주세요. 강의 업데이트되었으나 시간이 겹쳐 삭제되었을 때엔, LECTURE_REMOVE 타입입니다.

LINK_ADDR 타입

링크 주소 문자열을 담고 있습니다.

"https://snutt.kr"