出力フォーマット の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• 出力フォーマット へ行く。

[[FrontPage]]

&size(24){出力フォーマット};

#contents

* 出力フォーマットの指定 [#h7dbe87d]

APIのうち、パラメーターにFormat及びCharsetを取るものは、出力フォーマット及び文字コードを指定できる。~

** 出力フォーマット [#k3751f05]
APIでは JSON出力の使用を推奨する。

パラメーター Format
|取り得る値|フォーマット|特記事項|h
|json|JSON|文字コードはUTF-8に固定&br;マルチバイト文字はエスケープされる|
|xml|XML|文字コードはUTF-8に固定|
|yaml|YAML| |


** 出力文字コード [#s2a1985c]
APIでは UTF-8出力の使用を推奨し、他の文字コードでの使用は望ましくない。

|取り得る値|文字コード|h
|UTF-8|UTF-8|
|SJIS|シフトJIS|
|EUC-JP|EUC-JP|


* XML出力における特例 [#vab726f1]

出力フォーマットにXMLを指定した場合は、以下のルールが適用される。

- 特記なき限り、ルートノードは "response" となり、その下に各APIでの返却データ配列が配置される。
- 特記なき限り、返却データ配列のうちarray型のデータは、"item"タグとして列挙して配置される。
- 特記なき限り、boolean値の値は、true=1/false=それ以外 となる。

** 配列を含まないXML出力例 [#fb51a859]
#html{{
<pre class="brush:xml;">
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;response&gt;
    &lt;api_result&gt;1&lt;/api_result&gt;
    &lt;api_rescode&gt;1&lt;/api_rescode&gt;
    &lt;userid&gt;U9544c49952f15b274aa6e92d&lt;/userid&gt;
    &lt;allianceid&gt;IMD&lt;/allianceid&gt;
    &lt;loginid&gt;hhbcknlctzvy&lt;/loginid&gt;
    &lt;password&gt;jkzfzmkj&lt;/password&gt;
  &lt;/response&gt;
</pre>
}}
 
** 配列を含むXML出力例 [#e2b21a8c]
#html{{
<pre class="brush:xml;">
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;response&gt;
	&lt;api_result&gt;1&lt;/api_result&gt;
	&lt;struct&gt;
		&lt;item&gt;
			&lt;objectid&gt;FO29240fd24566d0583eace35c&lt;/objectid&gt;
			&lt;related&gt;
				&lt;item&gt;FO602dd9eb47944ae36e71e45e&lt;/item&gt;
				&lt;item&gt;FOf47edc2e462da61c2e7f6e4a&lt;/item&gt;
				&lt;item&gt;FOc3571f944566d05841da4085&lt;/item&gt;
				&lt;item&gt;FO3cc1bb8745d44ff97ba8c6fe&lt;/item&gt;
				&lt;item&gt;FO9a58f57646c9455b3ecac928&lt;/item&gt;
				&lt;item&gt;FO53e252d245d44ff7718e3607&lt;/item&gt;
			&lt;/related&gt;
		&lt;/item&gt;
	&lt;/struct&gt;
&lt;/response&gt;
</pre>
}}