SPIRAL PLACE APIでは、エラーの内容に応じてHTTPステータスコードを利用してエラーを返します。
エラーコード
| ステータスコード | ステータス | エラー原因・説明 |
|---|---|---|
| 400 | Bad Request | リクエストしたAPIに対応するリクエストメソッドではない場合に発生 |
| 401 | Unauthorized | API側が期待している値でない場合に発生 ※アクセストークンの値が異なる場合 など |
| 403 | Forbidden | 取得しようとしたリソースに対して閲覧権限がない場合に発生 ※カレンダー予定を取得しようとした際に閲覧できない予定だった場合 など |
| 404 | NotFound | リソースが見つからない場合に発生 ※リクエスト時の値からユーザーが見つからなかった場合 など |
| 500 | Internal Server Error | |
| 503 | Service Unavailable |
フォーマット
| キー | 値 |
|---|---|
| code | HTTPステータスコード |
| message | ステータスコードに応じたエラーメッセージ |
| reason | エラー原因 |
| fields | フィールドの入力値に関するエラーの詳細オブジェクト フィールドエラー参照 |
例：無効なアクセストークンでリクエストされた場合
{
code: 401,
reason: "access_token is invalid.",
message: "401 Unauthorized"
}例：必須のパラメータが指定されていない場合
{
"code": 400,
"reason": "required parameters: example2, example1.",
"message": "400 Bad Request"
}フィールドエラー
リクエストボディにリソースフィールドへの入力値が含まれているメソッドで、入力値に何らかの問題があった場合には問題の詳細情報が「fields」パラメータで返されます。
| キー | 値 |
|---|---|
| エラーの発生しているフィールド名 | そのフィールドに発生しているエラー情報リスト |
フォームエラーの種類
| エラー | 説明 |
|---|---|
| required | 必須項目が入力されていません |
| duplicated | 重複不可です |
| too_long | フィールドの許容文字数をオーバーしています |
| too_short | フィールドの許容文字数に足りていません |
| too_large | フィールドの許容値をオーバーしています |
| too_small | フィールドの許容値に足りていません |
| invalid | フィールド値のフォーマットと一致していないなど不正な値が指定されています |
| invalid_choice | 指定された値が選択肢にありません |
| out_of_range | 指定された値はフィールドの許容範囲外です |
例：スタッフ作成
リクエストボディ
{
"login_key": "hogehoge",
"last_name": "パイプ",
"first_name": "",
"last_name_kana": "フィールドのフォーマットに反している文字列や許容文字数に収まらない場合はエラーになります",
"first_name_kana": "たろう",
"memo": "",
"email1": "abc",
"email2": "",
"password": "123",
"is_admin": false
}レスポンスボディ
{
"fields": {
"last_name_kana": [
"invalid",
"too_long"
],
"first_name": [
"required"
],
"password": [
"invalid",
"too_short"
],
"email1": [
"invalid"
]
},
"reason": "invalid fields.",
"code": 400,
"message": "400 Bad Request"
}400 Bad Request が返されるケースについて
フィールド入力値やパラメータに関するエラー以外に、アカウントの設定内容や実行しようとしている処理によって以下のようなエラーが返されることがあります。
グループ
| メソッド | reason | 説明 |
|---|---|---|
| 作成 | exceeding maximum limit of groups with count. | アカウントで作成可能なグループ数を超えています。 |
設備・施設
| メソッド | reason | 説明 |
|---|---|---|
| 作成 | exceeding maximum limit of facilities with count. | アカウントで作成可能な設備・施設数を超えています。 |
予定
| メソッド | reason | 説明 |
|---|---|---|
| リスト | to_date must be later than from_date. | to_dateにはfrom_dateより遅い日付を指定してください。 |
| リスト | from_date must be before than '9999-11-30'. | from_dateは9999年11月30日よりも前で指定してください。 |
| リスト | to_date must be before than '9999-11-30'. | to_dateは9999年11月30日よりも前で指定してください。 |
| 作成, 変更, 部分変更予定追加 | no date to match this repeat rule. | 繰り返し条件に合った日付が1件もありません。 |
| 部分変更予定追加 | use "PUT" method to update repeat event whole. | 繰り返し予定の全体を変更するにはPUTメソッドを使用してください。 |
| 部分変更予定追加 | no update. | 変更がありません。 |
| 部分変更予定追加 | When scope is "spot", frequency must be "spot". | scopeを「spot」に指定している場合、繰り返し予定に部分変更することはできません。 |
トピック
| メソッド | reason | 説明 |
|---|---|---|
| 内容確認済みユーザーのリスト | This message does not have confirmation option. | 内容確認のないトピックです。 |
タスク
| メソッド | reason | 説明 |
|---|---|---|
| 変更 | can't update telephone memo. | 電話メモは変更できません。 |
| 部分変更 | can't update telephone memo. | 担当者でないユーザーはタスクの完了状態を変更できません。 |
| 部分変更 | task is already completed/incompleted. | 既に完了済み（未完了）のタスクです。 |
| 部分変更 | can't share telephone memo. | 電話メモは共有できません。 |
新着通知
| メソッド | reason | 説明 |
|---|---|---|
| 既読にする | already read. | 既に既読の通知です。 |
スパイラル株式会社からのお知らせ
| メソッド | reason | 説明 |
|---|---|---|
| 既読にする | already read. | 既に既読の通知です。 |