ServerAPIComments - observoice Wiki - observoice

コメント一覧取得

コメントの一覧を取得します。

URL

http://[hostname]/api/courses/{courseId}/comments.json

リクエストメソッド

GET

フォーマット

JSON

エラー

ステータスコード	内容
400	パラメータが不正

パラメータ

パラメータ名	型	内容	デフォルト	例	備考
count	数値	取得するコメントの件数	100	40
since	日付	以降のコメント	-	Sun, 01 Jun 2012 12:00:00 +0900	RFC2822 (SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss Z"))
until	日付	以前のコメント	-	Sun, 01 Jun 2012 12:00:00 +0900	RFC2822 (SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss Z"))
order	文字列	ソート順	desc	asc	desc=作成日の降順, asc=作成日の昇順

レスポンス

パラメータ名	型	内容	例	備考
result	配列	コメントの一覧	-
- commentId	数値	コメントのID	1234
- userId	文字列	コメントしたユーザID	12M34567
- nickname	文字列	コメントしたユーザのニックネーム	NICKNAME
- type	数値	0=わからない, 1=わかった	0
- content	文字列	コメントの内容	可能世界とは?
- created	日付	コメントの投稿日	Sun, 01 Jun 2012 12:00:00 +0900	RFC2822 (SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss Z"))
count	数値	コメントの一覧総数	2

レスポンスの例

{
  "result": [
    {
      "commentId": 1234,
      "userId": "12M34567",
      "nickname": "NICKNAME",
      "type": 0,
      "content": "可能世界とは?",
      "created": "Sun, 01 Jun 2012 12:00:00 +0900",
    },
    {
      ...
    }
  ],
  "count": 2,
}