目的のAPIに許可要求を送信した後、Control Managerは要求が成功したかどうかを示す応答を返します。
この応答は、常に次のようなJSON形式のAPIResponseObjectになります。
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":"(if provided, a
JSON object representing the
return value of the API)"
}
注:
result_codeステータス値の全リストについては、自動APIの結果コードを参照してください。
重要:
応答本文内のResult_descriptionフィールドは変更されることがあります。アプリケーションがControl Manager自動APIの応答に依存している場合は、応答本文内で提供されるresult_descriptionではなくresult_codeの値を使用してください。
次の表は、有効な応答の概要を示しています。
|
応答ステータス |
HTTPステータスコード |
応答本文 |
|---|---|---|
|
成功 |
200 |
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":"(if provided, a
JSON object representing the
return value of the API)"
}
注:
result_codeステータス値の全リストについては、自動APIの結果コードを参照してください。 |
|
無効なパラメータによる失敗 |
400 |
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":""
}
注:
result_codeステータス値の全リストについては、自動APIの結果コードを参照してください。 |
|
認証エラーによる失敗 |
401 |
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":""
}
注:
result_codeステータス値の全リストについては、自動APIの結果コードを参照してください。 |
|
不明なエラー |
500 |
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":""
}
注:
result_codeステータス値の全リストについては、自動APIの結果コードを参照してください。 |