【できごと】取得
TimeLine上の【できごと】を取得するAPIについて説明します。
リクエストURL
- 機能：
- 「:id」で指定した【できごと】を取得します。
リクエストメソッド
GETまたはPOST
リクエスト
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| id | 【できごと】のID | 【できごと】のID (URLのパスに含めてください。) | ◯ | 数値 | なし |
| timeline_key | APIキー | APIのユーザ認証するためのキー (プライベートモードのタイムライン上の【できごと】を参照する場合に必要となります。APIキーについて,詳しくはAPIキーについてを参照してください。) | - | 英数字 | なし |
サンプルリクエストURL
【できごと】(ID=13)の情報を取得するには次のURLにアクセスします。
レスポンス
レスポンスは以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
| result | ||
| article | 【できごと】の詳細 |
「【できごと】の詳細」は以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| id | 【できごと】のID | 数値 |
| title | 【できごと】のタイトル | 文字列 |
| description | 【できごと】の詳細 | 文字列 |
| owner | 【できごと】の作成者のニックネーム | 文字列 |
| start_time | 【できごと】の開始日時 | 日時 |
| end_time | 【できごと】の終了日時 | 日時 |
| grade | 【できごと】の縦軸の値 | 数値 |
| label | 【できごと】の縦軸のラベル | 文字列 ※1 |
| image | 【できごと】の画像のURL | URL |
| link | 【できごと】のパーマリンクURL | URL |
| related_links | ||
| url | 【できごと】の関連URL(0から3つ) | URL |
| updated_at | 【できごと】の更新日時 | 日時 |
| created_at | 【できごと】の作製日時 | 日時 |
※ 1 【できごと】の縦軸のラベルはタイムラインの縦軸モードが「文字モード」に設定されている場合のみ値が入ります。
縦軸モードが「数値モード」の場合には空要素となります。
各モードの詳細については縦軸モードについてを参照してください
サンプルレスポンス
以下は、ID=1の【できごと】を取得するリクエストに対するレスポンスです。
エラー
存在しない【できごと】や、閲覧権限のないタイムライン上の【できごと】を指定した場合はエラーとなります。
