エピソードへの記録を取得・作成・編集・削除するエンドポイントです。
リクエストの送り方やページネーションについてはREST API V1の概要をご参照ください。
作品全体への感想はREST API V1の作品へのレビューで扱います。
GET /v1/records
エピソードへの記録を取得することができます。
フィールド
| 名前 | 概要 |
|---|---|
| id | 記録ID |
| comment | 記録したときに書かれた感想 |
| rating | [非推奨] 記録したときに付けられたレーティング。0 から 5 までの数値が入っています。今後は rating_state を参照して下さい。 |
| rating_state | 記録したときに付けられたレーティング。bad average good great の4種類が入っています。 |
| is_modified | この記録が編集されたかどうか |
| likes_count | Likeされた数 |
| comments_count | コメントされた数 |
| created_at | 記録された日時 |
| user | この記録をした利用者の情報。取得できるフィールドはREST API V1のユーザと同じです。 |
| work | この記録が紐づく作品情報。取得できるフィールドはREST API V1の作品と同じです。 |
| episode | この記録が紐づくエピソード情報。REST API V1のエピソードの id から record_comments_count までのフィールドが入ります。 |
パラメータ
| 名前 | 概要 | 使用例 |
|---|---|---|
| fields | レスポンスボディに含まれるデータのフィールドを絞り込みます。 | fields=id,comment |
| filter_ids | 記録を記録IDで絞り込みます。 | filter_ids=1,2,3 |
| filter_episode_id | 記録をエピソードIDで絞り込みます。 | filter_episode_id=1111 |
| filter_has_record_comment | 記録を感想のあるなしで絞り込みます。感想付きの記録のみに絞り込むときは true を、感想の無い記録のみに絞り込むときは false を指定します。 |
filter_has_record_comment=true |
| page | ページ数を指定します。 | page=2 |
| per_page | 1ページに何件取得するかを指定します。デフォルトは 25 件で、50 件まで指定できます。 |
per_page=30 |
| sort_id | 記録を記録IDで並び替えます。asc または desc が指定できます。 |
sort_id=desc |
| sort_likes_count | 記録をLikeされた数で並び替えます。asc または desc が指定できます。 |
sort_likes_count=desc |
リクエスト例
$ curl -X GET https://api.annict.com/v1/records?filter_episode_id=74669&access_token=(access_token)
{
"records": [
{
"id": 425551,
"comment": "ゆるふわ田舎アニメかと思ったらギャグと下ネタが多めのコメディアニメだった。これはこれで。",
"rating": 4,
"rating_state": "good",
"is_modified": false,
"likes_count": 0,
"comments_count": 0,
"created_at": "2016-04-11T14:19:13.974Z",
"user": {
"id": 2,
"username": "shimbaco",
"name": "Koji Shimba",
"description": "アニメ好きが高じてこのサービスを作りました。",
"url": "http://shimba.co",
"avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
"background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
"records_count": 1906,
"followings_count": 258,
"followers_count": 205,
"wanna_watch_count": 237,
"watching_count": 103,
"watched_count": 335,
"on_hold_count": 45,
"stop_watching_count": 244,
"created_at": "2014-03-02T15:38:40.000Z"
},
"work": {
"id": 4670,
"title": "くまみこ",
"title_kana": "くまみこ",
"title_en": "Kuma Miko",
"media": "tv",
"media_text": "TV",
"released_on": "",
"released_on_about": "",
"official_site_url": "http://kmmk.tv/",
"wikipedia_url": "https://ja.wikipedia.org/wiki/%E3%81%8F%E3%81%BE%E3%81%BF%E3%81%93",
"twitter_username": "kmmk_anime",
"twitter_hashtag": "kumamiko",
"episodes_count": 6,
"watchers_count": 609,
"season_name": "2016-spring",
"season_name_text": "2016年春"
},
"episode": {
"id": 74669,
"number": "1",
"number_text": "第壱話",
"sort_number": 10,
"title": "クマと少女 お別れの時",
"records_count": 183,
"record_comments_count": 53
}
}
],
"total_count": 1,
"next_page": null,
"prev_page": null
}
POST /v1/me/records
エピソードへの記録が作成できます。
このリクエストには「読み込み + 書き込み」のスコープを持つアクセストークンが必要になります。
パラメータ
| 名前 | 概要 | データ例 |
|---|---|---|
| episode_id | [必須] エピソードID | 1234 |
| comment | 感想 | あぁ^～心がぴょんぴょんするんじゃぁ^～ |
| rating | [非推奨] 旧レーティング。今後は rating_state を使用してください。 |
4.5 |
| rating_state | レーティングの種類。bad average good great が入力できます。 |
great |
| share_twitter | 記録をTwitterにシェアするかどうか。true または false が入力できます。指定しなかったときは false (シェアしない) になります。 |
true |
| share_facebook | 記録をFacebookにシェアするかどうか。true または false が入力できます。指定しなかったときは false (シェアしない) になります。 |
true |
リクエスト例
$ curl -X POST "https://api.annict.com/v1/me/records?episode_id=5013&comment=あぁ^～心がぴょんぴょんするんじゃぁ^～&access_token=(access_token)"
レスポンスは、作成した記録1件を GET /v1/records の records に入る要素と同じ形式で返します。
PATCH /v1/me/records/:id
作成した記録を編集することができます。
このリクエストには「読み込み + 書き込み」のスコープを持つアクセストークンが必要になります。
パラメータ
| 名前 | 概要 | データ例 |
|---|---|---|
| id | [必須] 記録ID | 1016 |
| comment | 感想 | あぁ^～心がぴょんぴょんするんじゃぁ^～ |
| rating | [非推奨] 旧レーティング。今後は rating_state を使用してください。 |
4.5 |
| rating_state | レーティングの種類。bad average good great が入力できます。 |
great |
| share_twitter | 記録をTwitterにシェアするかどうか。true または false が入力できます。指定しなかったときは false (シェアしない) になります。 |
true |
| share_facebook | 記録をFacebookにシェアするかどうか。true または false が入力できます。指定しなかったときは false (シェアしない) になります。 |
true |
リクエスト例
$ curl -X PATCH "https://api.annict.com/v1/me/records/1016?comment=あぁ^～心がぴょんぴょんするんじゃぁ^～&access_token=(access_token)"
レスポンスは POST /v1/me/records と同じ形式です。
感想を書き換えた記録は is_modified が true になります。
DELETE /v1/me/records/:id
作成した記録を削除することができます。
このリクエストには「読み込み + 書き込み」のスコープを持つアクセストークンが必要になります。
パラメータ
| 名前 | 概要 | データ例 |
|---|---|---|
| id | [必須] 記録ID | 1016 |
リクエスト例
$ curl -X DELETE "https://api.annict.com/v1/me/records/1016?access_token=(access_token)"
HTTP/1.1 204 No Content