-
Notifications
You must be signed in to change notification settings - Fork 2
/
topic_search.html
368 lines (327 loc) · 13.4 KB
/
topic_search.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
<!DOCTYPE html>
<html lang="ja"><!-- InstanceBegin template="/Templates/template.dwt" codeOutsideHTMLIsLocked="false" -->
<head>
<meta charset="utf-8">
<!-- InstanceBeginEditable name="doctitle" -->
<title>topic/search.json</title>
<!-- InstanceEndEditable -->
<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<!-- Le styles -->
<link href="css/bootstrap.css" rel="stylesheet">
<link href="css/prettify.css" rel="stylesheet">
<script src="js/prettify.js"></script>
<script src="js/jquery.js"></script>
<style type="text/css">
body {
padding-top: 60px;
padding-bottom: 40px;
}
.sidebar-nav {
padding: 9px 0;
}
</style>
<link href="css/bootstrap-responsive.css" rel="stylesheet">
<!-- Le fav and touch icons -->
<!-- InstanceBeginEditable name="head" -->
<!-- InstanceEndEditable -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<style type="text/css">
body,td,th { font-family: Ubuntu, Tahoma, sans-serif; }
</style>
</head>
<body onload="prettyPrint()">
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="index.html">OpenPNE3 JSON API ドキュメント</a>
<div class="nav-collapse">
<ul class="nav">
<li class="active"><a href="">Home</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="container">
<div class="row">
<div id="t_navi" class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">ガイド</li>
<li><a href="guide_first.html"><i class="icon-chevron-right"></i>ファーストステップガイド</a></li>
<li><a href="guide_template.html"><i class="icon-chevron-right"></i>テンプレート利用ガイド</a></li>
<li class="nav-header">API Ver. 3.8</li>
<li><a href="api_common.html"><i class="icon-chevron-right"></i>共通仕様</a></li>
<li class="nav-header">アクティビティ（タイムライン）</li>
<li><a href="activity_search.html"><i class="icon-chevron-right"></i>activity/search.json</a></li>
<li><a href="activity_member.html"><i class="icon-chevron-right"></i>activity/member.json</a></li>
<li><a href="activity_friends.html"><i class="icon-chevron-right"></i>activity/friends.json</a></li>
<li><a href="activity_community.html"><i class="icon-chevron-right"></i>activity/community.json</a></li>
<li><a href="activity_post.html"><i class="icon-chevron-right"></i>activity/post.json</a></li>
<li><a href="activity_delete.html"><i class="icon-chevron-right"></i>activity/delete.json</a></li>
<li><a href="activity_mentions.html"><i class="icon-chevron-right"></i>activity/mentions.json</a></li>
<li class="nav-header">メンバー</li>
<li><a href="member_community.html"><i class="icon-chevron-right"></i>member/community.json</a></li>
<li><a href="member_search.html"><i class="icon-chevron-right"></i>member/search.json</a></li>
<li><a href="member_friend_accept.html"><i class="icon-chevron-right"></i>member/friend_accept.json</a></li>
<li><a href="member_friend_request.html"><i class="icon-chevron-right"></i>member/friend_request.json</a></li>
<li class="nav-header">コミュニティ</li>
<li><a href="community_search.html"><i class="icon-chevron-right"></i>community/search.json</a></li>
<li><a href="community_member.html"><i class="icon-chevron-right"></i>community/member.json</a></li>
<li><a href="community_join.html"><i class="icon-chevron-right"></i>community/join.json</a></li>
<li class="nav-header">通知センター</li>
<li><a href="push_search.html"><i class="icon-chevron-right"></i>push/search.json</a></li>
<li><a href="push_count.html"><i class="icon-chevron-right"></i>push/count.json</a></li>
<li><a href="push_read.html"><i class="icon-chevron-right"></i>push/read.json</a></li>
<li class="divider"></li>
<li class="nav-header">開発版API Ver. 3.9.x〜</li>
<li class="nav-header">トピック</li>
<li><a href="topic_post.html"><i class="icon-chevron-right"></i>topic/post.json</a></li>
<li><a href="topic_delete.html"><i class="icon-chevron-right"></i>topic/delete.json</a></li>
<li><a href="topic_search.html"><i class="icon-chevron-right"></i>topic/search.json</a></li>
<li class="nav-header">トピックコメント</li>
<li><a href="topic_comment_post.html"><i class="icon-chevron-right"></i>topic_comment/post.json</a></li>
<li><a href="topic_comment_delete.html"><i class="icon-chevron-right"></i>topic_comment/delete.json</a></li>
<li><a href="topic_comment_search.html"><i class="icon-chevron-right"></i>topic_comment/search.json</a></li>
<li class="nav-header">イベント</li>
<li><a href="event_post.html"><i class="icon-chevron-right"></i>event/post.json</a></li>
<li><a href="event_delete.html"><i class="icon-chevron-right"></i>event/delete.json</a></li>
<li><a href="event_search.html"><i class="icon-chevron-right"></i>event/search.json</a></li>
<li class="nav-header">イベントコメント</li>
<li><a href="event_comment_post.html"><i class="icon-chevron-right"></i>event_comment/post.json</a></li>
<li><a href="event_comment_delete.html"><i class="icon-chevron-right"></i>event_comment/delete.json</a></li>
<li><a href="event_comment_search.html"><i class="icon-chevron-right"></i>event_comment/search.json</a></li>
<li class="nav-header">日記</li>
<li><a href="diary_post.html"><i class="icon-chevron-right"></i>diary/post</a></li>
<li><a href="diary_delete.html"><i class="icon-chevron-right"></i>diary/delete</a></li>
<li><a href="diary_search.html"><i class="icon-chevron-right"></i>diary/search</a></li>
<li><a href="diary_comment_post.html"><i class="icon-chevron-right"></i>diary_comment/post</a></li>
<li><a href="diary_comment_delete.html"><i class="icon-chevron-right"></i>diary_comment/delete</a></li>
<li><a href="diary_comment_search.html"><i class="icon-chevron-right"></i>diary_comment/search</a></li>
<!--
<li class="nav-header">ファイル</li>
<li><a href="file_upload.html"><i class="icon-chevron-right"></i>file/upload</a></li>
<li><a href="file_files.html"><i class="icon-chevron-right"></i>file/files</a></li>
<li><a href="file_search.html"><i class="icon-chevron-right"></i>file/search</a></li>
<li><a href="file_get.htm"><i class="icon-chevron-right"></i>lfile/get</a></li>
-->
</ul>
</div>
</div>
<div class="span9">
<div class="row">
<div class="span9">
<!-- InstanceBeginEditable name="EditMain" -->
<h2>topic/search.json 概要</h2>
<p>トピック一覧・トピック表示</p>
<p></p>
<h2>リクエスト</h2>
<table class="table table-striped table-bordered table-condensed">
<thead>
<tr>
<th>パラメータ</th>
<th>値</th>
<th>説明</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="label">target</span> <span class="label label-important">*必須</span></td>
<td><b>string</b></td>
<td>topic､community､memberが指定可能です｡<br />
topic : 一件のトピックを取得します<br />
community : コミュニティのトピック一覧を取得します<br />
member : メンバーの所属するコミュニティのトピック一覧を取得します</td>
</tr>
<tr>
<td><span class="label">target_id</span> <span class="label label-important">*必須</span></td>
<td><b>integer</b></td>
<td>targetがtopicの場合はtopic_idを､targetがcommunityの場合はcommunity_idを､targetがmemberの場合はmember_idを指定します｡</td>
</tr>
<tr>
<td><span class="label">format</span></td>
<td><b>string</b></td>
<td>取得フォーマットを指定します｡miniとnormalが指定できます｡このフィールドがない場合はnormalフォーマットになります｡</td>
</tr>
<tr>
<td><span class="label">max_id</span></td>
<td><b>integer</b></td>
<td>取得したいトピックIDの最大値を指定します。</td>
</tr>
<tr>
<td><span class="label">since_id</span></td>
<td><b>integer</b></td>
<td>取得したいトピックIDの最小値を指定します。</td>
</tr>
<tr>
<td><span class="label">count</span></td>
<td><b>integer</b></td>
<td>取得したいトピックの、取得件数を指定します。このパラメータを指定しなかった場合のデフォルトは15です。</td>
</tr>
</tbody>
</table>
<h2>レスポンス</h2>
<p></p>
<table class="table table-striped table-bordered table-condensed">
<thead>
<tr>
<th>フィールド名</th>
<th>説明</th>
<th>normalフォーマット</th>
<th>miniフォーマット</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="label">id</span></td>
<td>トピックID</td>
<td>○</td>
<td>○</td>
</tr>
<tr>
<td><span class="label">community_id</span></td>
<td>コミュニティID</td>
<td>○</td>
<td>○</td>
</tr>
<tr>
<td><span class="label">community_name</span></td>
<td>コミュニティの名前</td>
<td>○</td>
<td>○</td>
</tr>
<tr>
<td><span class="label">member</span></td>
<td>トピック所有者メンバーの情報(詳しくは レスポンスの共通仕様 を参照)</td>
<td>○</td>
<td></td>
</tr>
<tr>
<td><span class="label">name</span></td>
<td>トピックのタイトル</td>
<td>○</td>
<td>○</td>
</tr>
<tr>
<td><span class="label">body</span></td>
<td>トピックの本文</td>
<td>○</td>
<td>○</td>
</tr>
<tr>
<td><span class="label">created_at</span></td>
<td>トピックの作成時間</td>
<td>○</td>
<td></td>
</tr>
<tr>
<td><span class="label">images</span></td>
<td>トピックに添付された画像のリスト</td>
<td>○</td>
<td></td>
</tr>
<tr>
<td><span class="label">editable</span></td>
<td>トピックが編集可能どうかのフラグ</td>
<td>○</td>
<td></td>
</tr>
<tr>
<td><span class="label">latest_comment</span></td>
<td>トピック最新コメント</td>
<td></td>
<td>○</td>
</tr>
<tr>
<td><span class="label">latest_commnet_id</span></td>
<td>トピックの最新コメントのID</td>
<td></td>
<td>○</td>
</tr>
</tbody>
</table>
<h2>サンプルリクエスト normal</h2>
<pre>$ curl http://example.com/api.php/topic/search.json?id=1&apiKey=cdc4042edf74db746f5bf550039bf50979da2566aa514fc0aac8f57c56398be5&target=community&target_id=1</pre>
<br />
<h2>サンプルレスポンス normal</h2>
<pre class="prettyprint linenums">
{
"status": "success"
"data":[{
"id":"1",
"community_id":"1",
"community_name":"all",
"name":"bbbbbbbbbbb",
"member":{
"id":"1",
"profile_image":"http:\/\/example.com\/web\/images\/no_image.gif",
"screen_name":"OpenPNE\u541b",
"name":"OpenPNE\u541b",
"profile_url":"\/member\/1",
"friend":false,
"blocking":false,
"self":true,
"friends_count":0,
"self_introduction":null
},
"body":"bbbbb",
"created_at":"2012-09-28 19:25:39",
"editable":true,
"images":[]
}]
}
</pre>
<br />
<h2>サンプルリクエスト mini</h2>
<pre>$ curl http://example.com/api.php/topic/search.json?apiKey=cdc4042edf74db746f5bf550039bf50979da2566aa514fc0aac8f57c56398be5&target=community&target_id=1&format=mini</pre>
<br />
<h2>サンプルレスポンス mini</h2>
<pre class="prettyprint linenums">
{
"status":"success",
"data":[{
"id":"2",
"community_id":"1",
"community_name":"all",
"name":"cccccccccccc",
"body":"cccccccccccc",
"created_at":"2012-09-30 09:05:07",
"latest_comment":"",
"latest_comment_id":""
},
{
"id":"1",
"community_id":"1",
"community_name":"all",
"name":"bbbbbbbbbbb",
"body":"bbbbb",
"created_at":"2012-09-28 19:25:39",
"latest_comment":"bbb",
"latest_comment_id":"3"
}]
}
</pre>
<!-- InstanceEndEditable -->
</div><!--/span-->
</div><!--/row-->
</div><!--/span-->
</div><!--/row-->
<hr>
<footer>
<p>© Tejimaya Inc. 2012- All Rights Reserved.</p>
</footer>
</div><!--/.fluid-container-->
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="js/bootstrap.js"></script>
</body>
<!-- InstanceEnd --></html>