【できごと】削除
TimeLine上の【できごと】を削除するAPIについて説明します。
リクエストURL
- 機能:
- 「:id」で指定した【できごと】を削除します。この機能を利用できるのは、【できごと】の作成者か【できごと】を含むTimeLineの作成者だけです。
リクエストメソッド
POST
リクエスト
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| id | 【できごと】のID | 【できごと】のID (URLのパスに含めてください。) | ◯ | 数値 | なし |
| timeline_key | APIキー | APIのユーザ認証するためのキー (プライベートモードのタイムライン上の【できごと】を参照する場合に必要となります。APIキーについて,詳しくはAPIキーについてを参照してください。) | ◯ | 英数字 | なし |
サンプルリクエストURL
【できごと】(ID=13)を削除する場合は、以下のURLにアクセスします。
レスポンス
レスポンスは以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
| result | この要素には何も含みません。 |
サンプルレスポンス
エラー
存在しない【できごと】や、削除権限のないタイムライン上の【できごと】を指定した場合はエラーとなります。
