HTTP Status Code
このトピックでは、MTPush REST APIのHTTPレスポンスコード仕様を定義します。
MTPush Push APIの新しいv4 APIはこの仕様を満たしています。
ステータスコード定義
| コード | 説明 | 詳細な説明 |
|---|---|---|
| 200 | OK | 成功！ |
| 400 | 不正なリクエスト | リクエストが無効です。対応する説明で理由が説明されます。 |
| 401 | 未検証 | 検証情報がないか、検証に失敗しました。 |
| 403 | 拒否 | リクエストは理解されましたが、受け入れられません。対応する説明で理由が説明されます。 |
| 404 | 見つからない | リソースが存在しない、要求されたユーザーが存在しない、または要求形式がサポートされていません。 |
| 405 | 要求メソッドが不適切 | この操作はこのメソッドからのリクエストをサポートしていません。 |
| 410 | オフライン | 要求されたリソースはオフラインです。関連するお知らせを参照してください。 |
| 429 | 過度のリクエスト | リクエスト数が制限を超えています。対応する説明で具体的な理由が説明されます。 |
| 500 | 内部サービスエラー | サーバーで内部エラーが発生しました。問題を早急に解決するためにお問い合わせください。 |
| 502 | 無効なプロキシ | サービスサーバーがオフラインまたはアップグレード中です。後で再試行してください。 |
| 503 | サービスが一時的に無効 | サーバーがリクエストに応答できません。後で再試行してください。 |
| 504 | エージェントタイムアウト | サーバーは稼働中ですが、リクエストに応答できません。後で再試行してください。 |
準拠事項
- 正しいコードは必ず200でなければなりません。
- ビジネスロジックエラーコードは、4xxまたは400を使用します。
- サーバー側の内部エラーコードは、5xxまたは500を使用します。
- ビジネスが異常な場合、返されるコンテンツはJSON形式を使用してエラー情報を定義します。
