mixi Connect » mixi Graph API » 技術仕様 » リクエスト削除API
リクエスト削除API
リクエスト削除APIは、mixiアプリから送信されたリクエストを削除する機能です。
ユーザが、友人から届いたリクエストを受け取らずに直接アプリを起動し、そのアプリでリクエストに対する処理が行われてしまった際、mixi内に保持されているリクエストはそのままとなり不整合が生じます。また、送信されたリクエストにアプリ内で期限が設けられていた場合にも、アプリからmixiに保持されている期限切れのリクエストを削除したくなるでしょう。
事前に必要なもの
リクエスト削除APIを利用するためには、以下の情報をすでに入手している必要があります。
- “mixi_apps2”スコープについて認可されたアクセストークン
上記以外のスコープで認可されたアクセストークンを使用して、リクエスト削除APIにアクセスすることはできません。現状では、 mixi_apps2スコープはmixiアプリやmixi API SDK for Android、mixi API SDK for iOSからのみ利用することが可能です。
リクエスト削除APIで提供される機能とスコープ
リクエスト削除APIでは以下のスコープで機能が提供されています。
| スコープ | 機能 | メソッド |
|---|---|---|
| mixi_apps2 | リクエストの削除 | DELETE |
詳しくはmixiアプリのユーザ認可処理や、mixi API SDK for Android?の初期化と認可処理、mixi API SDK for iOSの初期化と認可処理をご参照ください。
リクエストの削除
リクエストを削除するためのURIは以下になります。
DELETE https://api.mixi-platform.com/2/apps/requests/@me/@self?requestIds={Request-IDs}
指定可能なパラメータは以下となります。
| パラメータ名 | 内容 |
|---|---|
| Request-IDs |
リクエストIDをカンマ区切りで指定します。 一度に10個まで指定可能です。 |
リクエストが正しく処理された場合は、ステータスコード200番が返されます。
エラーコード
もし処理に失敗した場合は、ステータスコード400番台と共に、そのエラーの内容を持つ以下のようなJSON文字列が返却されます。
| 状況 | ステータスコード | errorの値 | error_descriptionの値 |
|---|---|---|---|
| 認証情報が不正(selectorが無効) | 403 | permission_denied | Permission denied |
| 削除対象が指定されていない | 400 | parameter_absent | A required parameter wasn't received |
| 削除対象の指定数が不正 | 400 | parameter_invalid | The parameter was invalid |
{
"error" : "permission_denied",
"error_description" : "Permission denied"
}