[关闭]
@fuyb1986 2016-06-24T03:30:29.000000Z 字数 5074 阅读 622

通知文档

欣略

1. 创建通知消息

Description

当前用户向接受者发送通知消息

Method and URL Structure

Method Resource URL
POST /notification/send/

Request Parameters

Name Description Required Default
title 通知的标题 Yes
content 通知内容 No
receiver 接收者账号 Yes
question 某一问题资源pk/id No
answer 某一答案资源pk/id No

选填字段question／answer，如果该字段值为空，就不传该字段

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

Request

  1. {
  2.     "title":"老师问好",
  3.     "content":"你好吗",
  4.     "question":1,
  5.     "answer":1,
  6.     "receiver":"student",
  7. }

cURL Example

  1. curl -X POST -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d 'title=老师问好&receiver=student&content=你好吗?&question=1&answer=1' http://127.0.0.1:8000/notification/send/

JSON Response

  1. {
  2.     "pk": 3,
  3.     "sender": "teacher",
  4.     "receiver": "student",
  5.     "title": "老师问好",
  6.     "content": "你好吗?",
  7.     "read": false,
  8.     "question": 1,
  9.     "answer": 1,
  10.     "create_time": "2016-04-14T09:03:33.302410Z"
  11. }

2. 所收到的通知消息

Description

用户所收到的通知信息

Method and URL Structure

Method Resource URL
GET /notification/inbox/

Request Parameters

默认分页取数据库中最新的10条数据

Name Description Required Default
read 课程名 No
page page Number Yes 1
  • read参数有值且不为空时，获取的是所有已读消息
  • read参数为空值时，获取的是未读消息
  • read参数字段缺失时，获取的是所有消息

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d 'page=1&read=true' http://127.0.0.1:8000/notification/inbox/

JSON Response

  1. {
  2.     "count": 2,
  3.     "next": null,
  4.     "previous": null,
  5.     "results": [
  6.         {
  7.             "pk": 3,
  8.             "sender": "root",
  9.             "receiver": "teacher",
  10.             "title": "teacher-receiver-read",
  11.             "content": "",
  12.             "read": true,
  13.             "question": 5,
  14.             "answer": 4,
  15.             "create_time": "2016-04-14T07:16:10.627632Z"
  16.         },
  17.         {
  18.             "pk": 2,
  19.             "sender": "root",
  20.             "receiver": "teacher",
  21.             "title": "teacher-receiver-read",
  22.             "content": "",
  23.             "read": true,
  24.             "question": 5,
  25.             "answer": 4,
  26.             "create_time": "2016-04-14T07:16:10.627632Z"
  27.         }
  28.     ]
  29. }

3. 获取所有发出的消息

Description

用户获取所有自己发出的通知信息

Method and URL Structure

Method Resource URL
GET /notification/sent/

Request Parameters

默认分页取数据库中最新的10条数据

Name Description Required Default
read 课程名 No
page page Number Yes 1
  • read参数有值且不为空时，获取的是所有已读消息
  • read参数为空值时，获取的是未读消息
  • read参数字段缺失时，获取的是所有消息

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d 'page=1&read=' http://127.0.0.1:8000/notification/sent/

JSON Response

  1. {
  2.     "count": 2,
  3.     "next": null,
  4.     "previous": null,
  5.     "results": [
  6.         {
  7.             "pk": 1,
  8.             "sender": "teacher",
  9.             "receiver": "student",
  10.             "title": "d",
  11.             "content": "",
  12.             "read": false,
  13.             "question": 5,
  14.             "answer": 2,
  15.             "create_time": "2016-04-14T07:03:34.769930Z"
  16.         },
  17.         {
  18.             "pk": 4,
  19.             "sender": "teacher",
  20.             "receiver": "student",
  21.             "title": "teacher-sender",
  22.             "content": "",
  23.             "read": false,
  24.             "question": 5,
  25.             "answer": 4,
  26.             "create_time": "2016-04-14T07:32:08.978551Z"
  27.         }
  28.     ]
  29. }

4. 查看具体通知消息

Description

用户查询某一通知信息

Method and URL Structure

Method Resource URL
GET /notification/${pk}/

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/notification/1/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "sender": "teacher",
  4.     "receiver": "student",
  5.     "title": "d",
  6.     "content": "",
  7.     "read": false,
  8.     "question": 5,
  9.     "answer": 2,
  10.     "create_time": "2016-04-14T07:03:34.769930Z"
  11. }

1. 支付通知信息创建

Description

用户创建支付通知

Method and URL Structure

Method Resource URL
POST /notification/payment_notification_list/

Request Parameters

Name Description Required Default
title 支付标题 Yes
content 支付内容 No

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X POST -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' -d 'title=你收到10美元' http://127.0.0.1:8000/notification/payment_notification_list/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "receiver": "teacher",
  4.     "title": "你收到10美元",
  5.     "content": null,
  6.     "read": false,
  7.     "create_time": "2016-04-14T07:53:55.081723Z"
  8. }

2. 获取所有用户收到的支付消息

Description

用户查看所收到的支付通知

Method and URL Structure

Method Resource URL
GET /notification/payment_notification_list/

Request Parameters

默认分页取数据库中最新的10条数据

Name Description Required Default
page page Number Yes 1

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/notification/payment_notification_list/

JSON Response

  1. {
  2.     "count": 2,
  3.     "next": null,
  4.     "previous": null,
  5.     "results": [
  6.         {
  7.             "pk": 1,
  8.             "receiver": "teacher",
  9.             "title": "你收到10美元",
  10.             "content": null,
  11.             "read": false,
  12.             "create_time": "2016-04-14T07:53:55.081723Z"
  13.         },
  14.         {
  15.             "pk": 2,
  16.             "receiver": "teacher",
  17.             "title": "你收到10美元",
  18.             "content": null,
  19.             "read": false,
  20.             "create_time": "2016-04-14T08:02:50.383718Z"
  21.         }
  22.     ]
  23. }

3. 获取收到的某一支付消息

Description

用户查看具体的支付通知

Method and URL Structure

Method Resource URL
GET /notification/payment_notification/${pk}

Request Header

Name Description Required Default
Authorization Token 7309fabd207c22e0a00eada158989b89ffe839ef Yes

＊Authorization的值为登录成功后返回值

cURL Example

  1. curl -X GET -H 'Authorization: Token 7309fabd207c22e0a00eada158989b89ffe839ef' http://127.0.0.1:8000/notification/payment_notification/1/

JSON Response

  1. {
  2.     "pk": 1,
  3.     "receiver": "teacher",
  4.     "title": "你收到10美元",
  5.     "content": null,
  6.     "read": false,
  7.     "create_time": "2016-04-14T07:53:55.081723Z"
  8. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注