API共通エラー情報

API共通のエラー情報（レスポンス）を以下に示します。

ステータス

リクエストのステータスを返却する。

400：
パラメーターに不正がある場合。
401：
認証エラー。認証トークンが存在しない場合、または認証トークンに誤りがある場合。
403：
認可エラー。契約者でない場合。
404：
存在しないURLが指定された場合、またはURLの指定に誤りがある場合。
500：
予期せぬエラーが発生した場合。

この場合、レスポンスボディは返却しません。

Data Type Cardinality
Int 1..1

エラー情報は以下のように返却されます。

Response Headers

Content-Length

ヘッダーを除いたリクエスト長(Byte)。

Data Type Cardinality
String 1..1

Content-Type

コンテントタイプ。

text/plain：
ステータスが401の場合。
application/json：
ステータスが401以外の場合。
Data Type Cardinality
String 1..1

Date

レスポンスの日時。

Data Type Cardinality
String 1..1

WWW-Authenticate

認証サービスのURL。認証エラーの場合のみ出力されます。

Data Type Cardinality
String 0..1

Response Elements（ステータスが401の場合）

以下のテキストを返却します。

"Authentication required"

Response Elements（ステータスが401,500以外の場合）

error

エラー情報コンテナ。

Data Type Cardinality Parent Element Child Element(s)
Element 1..1 None code

title

message

item

code

エラーコード。

Data Type Cardinality Parent Element Child Element(s)
Stinrg 1..1 error None

title

エラー概要。

Data Type Cardinality Parent Element Child Element(s)
String 1..1 error None

message

エラーメッセージ。

Data Type Cardinality Parent Element Child Element(s)
String 1..1 error None

item

項目エラー（項目エラーがある場合のみ通知）

Data Type Cardinality Parent Element Child Element(s)
Element 0..1 error item_name

item_name

エラーとなった項目名（リクエスト時のパラメーター名）

Data Type Cardinality Parent Element Child Element(s)
String

Element

 1..1 item message

message

項目に対するエラーメッセージ

Data Type Cardinality Parent Element Child Element(s)
String 1..1 item_name None

エラーコード（code,title,message）

code title message Description
400 Bad Request Parse error リクエストボディが正しくない。

（JSON形式でない、ルートエレメントが異なる）
400 Bad Request Parameter error. パラメーターエラー

入力内容が正しくない。
400 Bad Request Could not find user. (%1) 指定されたユーザーIDは存在しない。

%1は指定されたユーザーID。
400 Bad Request Could not match user in domain. 指定されたユーザーIDはドメインのユーザーでない。
400 Bad Request The contract is not active. 契約中でない。
400 Bad Request Email address cannot be used. 指定されたメールアドレスは使用不可である。
400 Bad Request The user was already contractor. 指定されたユーザーは既に契約者である。
404 Not Found Could not find domain. (%1) 指定されたドメインIDは存在しない。

%1は指定されたドメインID。

項目エラー（item）

message Description
Required. 必須項目
Size error. (Min:%min, Max:%max) サイズエラー
%min：
許容最小文字数

(省略可能な項目の場合はゼロを設定。)

%max：
許容最大文字数
Invaid format. 書式が誤っている。

パスワードにユーザー名が含まれている場合、メールアドレス中に"＠記号"が含まれていない場合等が該当します。
Invalid type. 許可されない値が指定されている。

"A","B","C"のみ指定可能なフィールドに"D"を設定した場合など。
Not found. 指定値に該当する情報は未登録である。
Already exists. 指定値に該当する情報は既に存在する。

Example of Response

パラメーターエラーの場合


{
  "error": {
    "code": 400,
    "title": "Bad Request",
    "message": "Parameter error.",
    "item": {
      "secure": {
        "name": {
          "first": {
            "message": "Required."
          },
          "last": {
            "message": "Size error. (Min:0, Max:64)"
          }
        }
      }
    }
  }
}

認証エラーの場合


Authentication required

認可エラーの場合


{
  "error" : {
    "code" : 403,
    "title" : "Forbidden",
    "message" : "Authorization error."
  }
}

存在しない組織を指定した場合


{
  "error" : {
    "code" : 404,
    "title" : "Not Found",
    "message" : "Could not find domain, 304ce7245683491ebaf91ad63c1dd2c."
  }
}