CFMG APIの説明形式を説明します。
リクエストパラメーター
CFMG APIのリクエストパラメーターを表形式で説明します。
パラメーター名 | 項目 | 項目説明 |
|---|---|---|
リクエストパラメーター名(注) | 説明 | 各パラメーターの説明です。 |
型 | パラメーターの型です。 | |
設定内容 | 各パラメーターの設定内容です。固定値または実際の設定範囲の値を表現する場合には、具体的な値も説明します。 |
注)パラメーター名を[]で囲んでいる場合は、省略可能なパラメーターであることを示しています。
レスポンス
CFMG APIのレスポンスを説明します。
《ステータスコード》
ステータスコードについて説明します。
《XML》
XML形式であるレスポンスを説明します。
《要素》
要素ごとに表形式で説明します。
要素名 | 項目 | 項目説明 |
|---|---|---|
レスポンスの要素名 | 説明 | レスポンスの各要素の説明です |
型 | レスポンスの各要素の型です | |
出現回数 | レスポンスの各要素の出現回数です。要素名の親子関係によって出現回数が変化する場合についても、ここで説明しています。 |
サンプルレスポンス
CFMG APIのサンプルレスポンスを説明します。XML形式となっています。
注意
CFMG APIの出力結果は、レスポンスの説明とタグ出現の順序が異なる場合があります。
