以下のセクションには、11 の XML メソッド呼び出しの構造と応答、またエラーを報告するために使用される例外 XML についての概説があります。
XML の一般的な構造は以下のとおりです。
- ルート・エレメントは常に BCGPublicAPI エレメントです。
- 要求文書内のルートの最初の子は <MethodName> エレメントです。
- <MethodName> エレメントの最初の子は UserInfo エレメントです。このエレメントには、要求を行うユーザーのための Console ログイン情報が入っています。そのユーザーには、タスクを試みるために十分な許可がなければなりません。
- <MethodName> エレメントの 2 番目の子は、入力パラメーターを表します。
- 応答文書内のルートの最初の子は <MethodName>Response エレメントです。このエレメントは、要求 API の実行結果を表します。
- 例外文書内のルートの最初の子は BCGPublicAPIException エレメントです。
