|
|
第25行: |
第25行: |
| ** thread: 同主题模式 | | ** thread: 同主题模式 |
| ** origin: 原作模式 | | ** origin: 原作模式 |
− | ** zhiding: 置顶模式 | + | ** sticky: 置顶模式 |
| | | |
| === 列出版面 === | | === 列出版面 === |
2012年6月26日 (二) 17:35的版本
JSONP
Parameter |
Type |
Description |
Optional
|
jsonp |
string |
JSONP function name |
Yes
|
jsoncallback |
string |
JSONP function name |
Yes
|
If you want JSONP, just add jsonp=function, and the result would be
登录
BBS OAuth
版面
- 帖子列表模式(通常以mode参数出现):
- normal: 普通模式
- digest: 文摘模式
- mark: 被m模式
- thread: 同主题模式
- origin: 原作模式
- sticky: 置顶模式
列出版面
- GET /board/list
Parameter |
Type |
Description |
Optional
|
session |
string |
Session Token |
No
|
start |
int |
ID of the first post to list |
Yes
|
end |
int |
ID of the last post to list |
Yes
|
count |
int |
Number of posts to list |
Yes
|
- Return value
- Success: [{"name": <string: Board name>, "read": <Boolean: Board read?>, "BM": <string: BMs>, "id": <int: Board id>, "total": <int: Total post count>, "currentusers": <int: Current users count>, "major": <int: major class>, "minor": <string: minor class>, "outpost": <string: may outpost>, "desc": <string: description>},{...}...]
获取帖子列表
- GET /board/post_list
Parameter |
Type |
Description |
Optional |
Choices
|
session |
string |
Session Token |
No
|
name |
string |
Name of the board to list |
No
|
mode |
string |
Mode of this board to list |
Yes |
帖子列表模式
|
start |
int |
ID of the first post to list |
Yes
|
end |
int |
ID of the last post to list |
Yes
|
count |
int |
Number of posts to list |
Yes
|
- Return value
- Success: [{"posttime": <time: post time>, "attachflag": <int: unknown>, "read": <Boolean: Post read>, "title": <string: Post title>, "attachment": <int: Attachment count>, "owner": <string: Poster userid>, "id": <int: Post id>, "xid": <int: unique post ID>},
{...}...]
清除未读标记
- POST /board/clear_unread
Parameter |
Type |
Description |
Optional
|
session |
string |
Session Token |
No
|
name |
string |
Name of the board to list |
No
|
to |
int |
unique ID (xid) of the post to clear to |
Yes
|
如果不提供to参数,则清除所有。否则清楚从开始到指定帖子的未读标记。
帖子
获取帖子
- GET /post/view
Parameter |
Type |
Description |
Optional
|
session |
string |
Session Token |
No
|
id |
int |
ID of the post in this board |
No
|
board |
string |
Name of the board this post belongs to |
No
|
- Return value
- Success: {"picattach": [{"name": <string: Attachment filename>, "offset:": <int: Attachment offset in post>}, {...}...], "title": <string: Post title>, "content": <string: Post content>, "otherattach": [{...}...], "owner": <string: Poster>, "id": <int: Post ID>, "xid": <int: unique post ID>}
获取附件
- GET /post/get_attach
Parameter |
Type |
Description |
Optional |
Choices
|
session |
string |
Session Token |
No
|
id |
int |
ID of the post in this board |
No
|
board |
string |
Name of the board this post belongs to |
No
|
mode |
string |
Mode of the board this ID corresponds to |
Yes |
帖子列表模式
|
offset |
int |
Offset of the attachment in the post, returned in "view" |
No
|
- Result value
- {"content": <string: Post content encoded in Base64>, "name": <string: Attachment name>}
同主题浏览
- GET /post/nextid
Parameter |
Type |
Description |
Optional |
Choices
|
session |
string |
Session token |
No |
|
id |
int |
Post ID to start search from |
No |
|
board |
string |
Board name |
No |
|
direction |
string |
Search direction |
Yes |
forward/backward
|
last_one |
bool |
Search for the last post |
Yes |
0/1
|
only_new |
bool |
Only search for new post |
Yes |
0/1
|
- Result
- {'nextid': <int: next post id in the thread>}
- Examples
- direction=forward: search for next post in the same thread
- direction=backward, last_one=1: go to the head of the thread
- direction=backward, last_one=1, only_new=1: go to the first unread post in the thread
引用帖子
- GET /post/quote
Parameter |
Type |
Description |
Optional |
Choices
|
session |
string |
Session Token |
No
|
board |
string |
Name of the board this post belongs to |
No
|
id |
int |
ID of the post to quote |
No
|
xid |
int |
unique ID of the post to quote |
No
|
mode |
string |
quote mode |
Yes |
S/R/N/A
|
index_mode |
string |
mode of the post list where ID belongs to |
Yes |
帖子列表模式
|
- Result
- {"title": <string: Quoted title>, "content": <string: Quoted content>}
准备
- GET /post/prepare
Parameter |
Type |
Description |
Optional |
Choices
|
session |
string |
Session Token |
No |
|
for |
string |
action to prepare for |
No |
new
|
board |
string |
Name of the board this post belongs to |
No |
|
re_id |
int |
ID of the post to reply (for=new) |
Yes |
|
re_xid |
int |
unique ID of the post to reply (for=new) |
Yes |
|
re_mode |
string |
mode of the post list where re_id belongs to (for=new) |
Yes |
帖子列表模式
|
anonymous |
boolean |
create anonymous post (for=new) |
Yes |
0(no)/1(yes)
|
result: {"error": {<string: error>: 1}}
如果没错误,那后面的hash是空的。
发帖/回帖
- POST /post/new
Parameter |
Type |
Description |
Optional |
Choices
|
session |
string |
Session Token |
No |
|
board |
string |
Name of the board this post belongs to |
No |
|
re_id |
int |
ID of the post to reply |
Yes |
|
re_xid |
int |
unique ID of the post to reply |
Yes |
|
re_mode |
string |
mode of the post list where re_id belongs to |
Yes |
帖子列表模式
|
title |
string |
title of the post |
No |
|
content |
string |
content of the post |
No |
|
signature_id |
int |
No. of qmd to use |
Yes |
<0(random)/0(none)/>0(qmd #)
|
anonymous |
boolean |
create anonymous post |
Yes |
0(no)/1(yes)
|
mailback |
boolean |
require replies to be mailed back |
Yes |
0(no)/1(yes)
|
发帖的话,id和xid可以忽略。回帖的话,需要提供id和xid。
收藏夹
列出收藏夹
- GET /favboard/list
Parameter |
Type |
Description |
Optional
|
session |
string |
Session Token |
No
|
father |
int |
Parent directory of boards to list |
Yes
|
start |
int |
ID of the first post to list |
Yes
|
end |
int |
ID of the last post to list |
Yes
|
count |
int |
Number of posts to list |
Yes
|
- Return value
- Success: [{"index": <int: Index in favboard>, "binfo": <BoardInfo: board info>, "father": <int: Parent index in favboard>, "type": <string: Type of this entry>}, {...}...]
会话
验证会话
- GET /session/verify
Parameter |
Type |
Description |
Optional
|
session |
string |
Session Token |
No
|
用户
获取用户信息
- GET /user/query
Parameter |
Type |
Description |
Optional
|
session |
string |
Session Token |
No
|
id |
string |
ID of user to query |
No
|
获取默认签名档编号
- GET /user/signature_id
Parameter |
Type |
Description |
Optional
|
session |
string |
Session Token |
No
|
- Return value: {"signature_id": <int: default signature id>}