-
Notifications
You must be signed in to change notification settings - Fork 5
API Notification
Jang Ryeol edited this page Sep 18, 2016
·
15 revisions
현재 유저의 알림 목록을 반환합니다.
name | description | example |
---|---|---|
limit | 가져올 알림 개수. Default = 20 | 20 |
offset | 오프셋 (for paging). Default = 0 | 0 |
explicit | (Optional) 값에 관계없이 set되면 마지막 알림 체크 시간을 업데이트합니다(Unread count를 업데이트). 값이 주어지지 않으면 업데이트하지 않습니다. | 1 |
[
{
"_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",
"detail": {
"updated": [
{
"course_title": "공연예술의 이해",
"lecture_number": "001",
"course_number": "042.023",
"after": {
"course_title": "공연예술의 으미"
},
"before": {
"course_title": "공연예술의 이해"
}
}
],
"removed": [],
"created": []
},
"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": 2,
"user_id": "578cb77b81d0bdfe3aef888f",
"__v": 0
},
{
"_id": "5790de76756a8da1171269c3",
"message": "2015년도 겨울학기 수강 편람이 업데이트 되었습니다.",
"created_at": "2016-07-21T14:38:46.772Z",
"detail": {
"updated": [],
"removed": [
{
"course_title": "공연예술의 으미",
"lecture_number": "001",
"course_number": "042.023"
}
],
"created": []
},
"type": 1,
"user_id": null,
"__v": 0
}
]
detail
속성은 type에 따라 다른 구조를 가집니다. Notification Details 참고.
현재 유저가 읽지 않은 알림의 개수를 반환합니다.
개수를 반환
{
count: 7
}
현재 Notification에는 3가지 타입이 있습니다.
Type | Number | Description |
---|---|---|
NORMAL | 0 |
detail 이 null인 일반 텍스트 알림입니다. |
COURSEBOOK | 1 | 수강편람이 업데이트 되었을 때 모든 유저에게 전송되는 전역 알림입니다. |
LECTURE | 2 | 내 시간표에 있는 강좌가 업데이트가 되었을 때 강의별로 전송되는 개인 알림입니다. |
각 타입 별로 detail
필드에는 다른 값이 저장되어 있습니다. NORMAL
타입은 detail
이 null입니다.
{
"updated" : ["..."],
"removed" : ["..."],
"created" : ["..."]
}
COURSEBOOK
타입의 경우 위와 같이 세가지 필드가 있습니다. removed
와 created
에는 course_title
, course_number
, lecture_number
세가지 필드를 가진 강의 객체가 원소로서 저장됩니다. updated
의 경우에는 위의 세 필드와 함께 before
, after
필드가 있는데, 이는 각각 변경 내역을 담은 객체입니다. 오직 변경된 사항만 담고 있으며 자세한 예는 위 response 예제들을 참고해주세요.
LECTURE
타입의 경우 위 COURSEBOOK
타입과 유사합니다.
{
"lecture": {
".."
},
"timetable_id": ".."
}
강의가 업데이트 되었을 때와 폐강되었을 때가 다른데, 자세한 예는 역시 위 response 예제들을 참고해주세요. LECTURE
타입에는 timetable_id
가 추가됩니다.
- Home
- Conventions & License
- 서버 시작 및 수강편람 업데이트
- API List (for express branch)
- Error Codes
- Feedback
- Basics and Authentication
- Bookmark
- Coursebook
- Search Query
- Colors
- Tags
- Timetable
- Notification
- User
- Shared Timetables
- Client (for ver 2.0)
- StoryBoard